OStorageConfigurationImpl (OrientDB 2.2.37 API)

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

All Implemented Interfaces:

OStorageConfiguration, OSerializableStream, Serializable

Direct Known Subclasses:

OStorageConfigurationSegment, OStorageMemoryConfiguration, OStorageRemoteConfiguration
```
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
Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OStorageConfigurationImpl.IndexEngineData

Nested Classes
Modifier and Type	Class and Description
`static class`	`OStorageConfigurationImpl.IndexEngineData`

Field Summary

Fields
Modifier and Type Field and Description

OStorageSegmentConfiguration fileTemplate

protected OStorage storage

protected Charset streamCharset
- Fields inherited from interface com.orientechnologies.orient.core.config.OStorageConfiguration
  CONFIG_RID, CURRENT_BINARY_FORMAT_VERSION, CURRENT_VERSION, DEFAULT_CHARSET, DEFAULT_DATE_FORMAT, DEFAULT_DATETIME_FORMAT

Fields
Modifier and Type	Field and Description
`OStorageSegmentConfiguration`	`fileTemplate`
`protected OStorage`	`storage`
`protected Charset`	`streamCharset`

Constructor Summary

Constructors
Constructor and Description

OStorageConfigurationImpl(OStorage iStorage, Charset streamCharset)

Constructors
Constructor and Description
`OStorageConfigurationImpl(OStorage 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, OStorageConfigurationImpl.IndexEngineData engineData)`
`protected void`	`bindPropertiesToContext(Map<String,Object> iProperties)`
`void`	`clear()`
`void`	`clearProperties()`
`void`	`close()`
`void`	`create()`
`void`	`delete()`
`void`	`deleteIndexEngine(String name)`
`void`	`dropCluster(int iClusterId)`
`boolean`	`existsProperty(String iName)`
`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`	`getDateFormat()`
`SimpleDateFormat`	`getDateFormatInstance()`
`String`	`getDateTimeFormat()`
`SimpleDateFormat`	`getDateTimeFormatInstance()`
`String`	`getDictionaryRecordId()`
`String`	`getDirectory()`
`OStorageConfigurationImpl.IndexEngineData`	`getIndexEngine(String name)`
`String`	`getIndexMgrRecordId()`
`Map<String,Object>`	`getLoadProperties()`
`String`	`getLocaleCountry()`
`Locale`	`getLocaleInstance()`
`String`	`getLocaleLanguage()`
`int`	`getMinimumClusters()`
`String`	`getName()`
`List<OStorageEntryConfiguration>`	`getProperties()`
`String`	`getProperty(String iName)`
`String`	`getRecordSerializer()`
`int`	`getRecordSerializerVersion()`
`String`	`getSchemaRecordId()`
`TimeZone`	`getTimeZone()`
`DecimalFormatSymbols`	`getUnusualSymbols()`
`int`	`getVersion()`
`Set<String>`	`indexEngines()`
`void`	`initConfiguration()`
`boolean`	`isEmpty()`
`boolean`	`isStrictSql()`
`boolean`	`isTxRequiredForSQLGraphOperations()`
`boolean`	`isValidationEnabled()`
`OStorageConfigurationImpl`	`load(Map<String,Object> iProperties)` This method load the record information by the internal cluster segment.
`void`	`lock()`
`void`	`removeProperty(String iName)`
`void`	`resetLocaleInstance()`
`void`	`setCharset(String charset)`
`void`	`setClusterSelection(String clusterSelection)`
`void`	`setClusterStatus(int clusterId, OStorageClusterConfiguration.STATUS iStatus)`
`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`	`setIndexMgrRecordId(String indexMgrRecordId)`
`void`	`setLocaleCountry(String iValue)`
`void`	`setLocaleLanguage(String iValue)`
`void`	`setMinimumClusters(int minimumClusters)`
`void`	`setProperty(String iName, String iValue)`
`void`	`setRecordSerializer(String recordSerializer)`
`void`	`setRecordSerializerVersion(int recordSerializerVersion)`
`void`	`setSchemaRecordId(String schemaRecordId)`
`void`	`setSoftlyClosed(boolean softlyClosed)`
`void`	`setTimeZone(TimeZone timeZone)`
`void`	`setValidation(boolean validation)`
`void`	`synch()`
`byte[]`	`toStream()` Deprecated. because method uses native encoding use `toStream(Charset)` instead.
`byte[]`	`toStream(Charset charset)`
`byte[]`	`toStream(int iNetworkVersion, Charset charset)`
`void`	`unlock()`
`void`	`update()`

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

Field Detail

storage

protected final transient OStorage storage

fileTemplate

public volatile OStorageSegmentConfiguration fileTemplate

streamCharset
```
protected final Charset streamCharset
```

Constructor Detail

OStorageConfigurationImpl

public OStorageConfigurationImpl(OStorage iStorage,
                                 Charset streamCharset)

Method Detail
- setCreationVersion
```
public void setCreationVersion(String version)
```
  Sets version of product release under which storage was created.
- initConfiguration
```
public void initConfiguration()
```
- clear
```
public void clear()
```
- 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(Map<String,Object> iProperties)
                               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
- getLoadProperties
```
public Map<String,Object> getLoadProperties()
```
- getBinaryFormatVersion
```
public int getBinaryFormatVersion()
```
  Specified by:
  
  getBinaryFormatVersion in interface OStorageConfiguration
- update
```
public void update()
            throws OSerializationException
```
  Throws:
  
  OSerializationException
- isEmpty
```
public boolean isEmpty()
```
- getDirectory
```
public String getDirectory()
```
  Specified by:
  
  getDirectory in interface OStorageConfiguration
- addCluster
```
public void addCluster(OStoragePaginatedClusterConfiguration config)
```
- getLocaleInstance
```
public Locale getLocaleInstance()
```
  Specified by:
  
  getLocaleInstance in interface OStorageConfiguration
- resetLocaleInstance
```
public void resetLocaleInstance()
```
- getDateFormatInstance
```
public SimpleDateFormat getDateFormatInstance()
```
  Specified by:
  
  getDateFormatInstance in interface OStorageConfiguration
- getDateTimeFormatInstance
```
public SimpleDateFormat getDateTimeFormatInstance()
```
  Specified by:
  
  getDateTimeFormatInstance in interface OStorageConfiguration
- getUnusualSymbols
```
public DecimalFormatSymbols getUnusualSymbols()
```
- 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
```
@Deprecated
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)
```
- toStream
```
public byte[] toStream(int iNetworkVersion,
                       Charset charset)
                throws OSerializationException
```
  Throws:
  
  OSerializationException
- lock
```
public void lock()
          throws IOException
```
  Throws:
  
  IOException
- unlock
```
public void unlock()
            throws IOException
```
  Throws:
  
  IOException
- create
```
public void create()
            throws IOException
```
  Throws:
  
  IOException
- synch
```
public void synch()
           throws IOException
```
  Throws:
  
  IOException
- setSoftlyClosed
```
public void setSoftlyClosed(boolean softlyClosed)
                     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)
```
- getClusters
```
public List<OStorageClusterConfiguration> getClusters()
```
  Specified by:
  
  getClusters in interface OStorageConfiguration
- addIndexEngine
```
public void addIndexEngine(String name,
                           OStorageConfigurationImpl.IndexEngineData engineData)
```
- deleteIndexEngine
```
public void deleteIndexEngine(String name)
```
- getVersion
```
public int getVersion()
```
  Specified by:
  
  getVersion in interface OStorageConfiguration
- indexEngines
```
public Set<String> indexEngines()
```
  Specified by:
  
  indexEngines in interface OStorageConfiguration
- getIndexEngine
```
public OStorageConfigurationImpl.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
- setDateFormat
```
public void setDateFormat(String dateFormat)
```
- getDateTimeFormat
```
public String getDateTimeFormat()
```
  Specified by:
  
  getDateTimeFormat in interface OStorageConfiguration
- setDateTimeFormat
```
public void setDateTimeFormat(String dateTimeFormat)
```
- 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
- getSchemaRecordId
```
public String getSchemaRecordId()
```
  Specified by:
  
  getSchemaRecordId in interface OStorageConfiguration
- getIndexMgrRecordId
```
public String getIndexMgrRecordId()
```
  Specified by:
  
  getIndexMgrRecordId in interface OStorageConfiguration
- getDictionaryRecordId
```
public String getDictionaryRecordId()
```
  Specified by:
  
  getDictionaryRecordId in interface OStorageConfiguration
- setRecordSerializerVersion
```
public void setRecordSerializerVersion(int recordSerializerVersion)
```
- isStrictSql
```
public boolean isStrictSql()
```
  Specified by:
  
  isStrictSql in interface OStorageConfiguration
- isTxRequiredForSQLGraphOperations
```
public boolean isTxRequiredForSQLGraphOperations()
```
  Specified by:
  
  isTxRequiredForSQLGraphOperations in interface OStorageConfiguration
- getName
```
public String getName()
```
  Specified by:
  
  getName in interface OStorageConfiguration
- setSchemaRecordId
```
public void setSchemaRecordId(String schemaRecordId)
```
- setIndexMgrRecordId
```
public void setIndexMgrRecordId(String indexMgrRecordId)
```
- 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
- existsProperty
```
public boolean existsProperty(String iName)
```
- 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)
```
- bindPropertiesToContext
```
protected void bindPropertiesToContext(Map<String,Object> iProperties)
```

Class OStorageConfigurationImpl

Nested Class Summary

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

storage

fileTemplate

streamCharset

Constructor Detail

OStorageConfigurationImpl

Method Detail

setCreationVersion

initConfiguration

clear

getConflictStrategy

setConflictStrategy

getContextConfiguration

load

getLoadProperties

getBinaryFormatVersion

update

isEmpty

getDirectory

addCluster

getLocaleInstance

resetLocaleInstance

getDateFormatInstance

getDateTimeFormatInstance

getUnusualSymbols

fromStream

fromStream

toStream

toStream

toStream

lock

unlock

create

synch

setSoftlyClosed

delete

close

dropCluster

getClusters

addIndexEngine

deleteIndexEngine

getVersion

indexEngines

getIndexEngine

setClusterStatus

getTimeZone

setTimeZone

getLocaleLanguage

setLocaleLanguage

getLocaleCountry

setLocaleCountry

getCharset

setCharset

getDateFormat

setDateFormat

getDateTimeFormat

setDateTimeFormat

getClusterSelection

setClusterSelection

getMinimumClusters

setMinimumClusters

getRecordSerializer

setRecordSerializer

getRecordSerializerVersion

getSchemaRecordId

getIndexMgrRecordId

getDictionaryRecordId

setRecordSerializerVersion

isStrictSql

isTxRequiredForSQLGraphOperations

getName

setSchemaRecordId

setIndexMgrRecordId