VideoOS.Platform.ConfigurationItems.Storage Class Reference

More...

Inheritance diagram for VideoOS.Platform.ConfigurationItems.Storage:
VideoOS.Platform.ConfigurationItems.IConfigurationItem VideoOS.Platform.ConfigurationItems.IConfigurationItem VideoOS.Platform.ConfigurationItems.IConfigurationChildItem VideoOS.Platform.ConfigurationItems.IConfigurationChildItem

Public Member Functions

ChangeEncryptionMethodServerTask ChangeEncryptionMethod ()
 Change encryption method.
 
ServerTask ChangeEncryptionMethod (String encryptionMethod, System.Security.SecureString password)
 Change encryption method.
 
ChangePasswordStorageEncryptionServerTask ChangePasswordStorageEncryption ()
 Change encryption password for recording storage.
 
ServerTask ChangePasswordStorageEncryption (String oldPassword, String newPassword)
 Change encryption password for recording storage.
 
DisableEncryptionServerTask DisableEncryption ()
 Disable encryption on recording storage.
 
ServerTask DisableEncryption (System.Security.SecureString password)
 Disable encryption on recording storage.
 
EnableEncryptionServerTask EnableEncryption ()
 Enable encryption on recording storage.
 
ServerTask EnableEncryption (String password, String encryptionMethod)
 Enable encryption on recording storage
Please consider using secure version taking SecureString instead.
 
ServerTask EnableEncryption (System.Security.SecureString password, String encryptionMethod)
 Enable encryption on recording storage.
 
ClassCollectionServerTask GetDevicesUsingStorage ()
 Get devices using this storage.
 
MoveRecordingStorageServerTask MoveRecordingStorage ()
 Move storage.
 
ServerTask MoveRecordingStorage (String diskPath)
 Move storage.
 
ServerTask ReadStorageInformation ()
 Read storage information.
 
ServerTask SetStorageAsDefault ()
 Set storage as default.
 
 Storage (FQID fqid)
 Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID.
 
 Storage (ServerId serverId, ConfigurationItem storage)
 Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem.
 
 Storage (ServerId serverId, string path)
 Construct the class from serverId of the Management Server that owns the configuration, and the path of the item.
 
ValidateStorageEncryptionPasswordServerTask ValidateStorageEncryptionPassword ()
 Validate encryption password on recording storage.
 
ServerTask ValidateStorageEncryptionPassword (System.Security.SecureString password)
 Validate encryption password on recording storage.
 
- Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem
void ClearChildrenCache ()
 Clear the internal cache of children. Can be used to force a new set of children to be fetched from the server at next access.
 
ServerTask ExecuteMethod (string methodId)
 Execute the provided method. The method id must be one of the defined values in the Methods property.
 
void FillChildren (string[] itemTypes)
 Fill all children and grand-children - as long as the itemtype is contained in itemType parameter.
 
void FillChildren (string[] itemTypes, ItemFilter[] itemFilters)
 Fill all children and grand-children - as long as the itemtype is contained in itemType parameter and filters match. If multiple filters are defined for same itemtype, all must match for the item to be included ('and' operation).
If no filter is defined for an ItemType, then all items of that type is filled.
 
void Save ()
 Will save all updated values to server.
 
ValidateResult ValidateItem ()
 Validate the current content.
 
- Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem
string GetProperty (string key)
 Return a property value as string, if key is not found the return value will be null.
 
ICollection< string > GetPropertyKeys ()
 Get a collection of all available property keys.
 
List< ValueTypeInfoGetValueTypeInfoList (string propertyKey)
 Get defined ValueTypeInfo for a given property. If no ValueTypeInfo is available, an empty list is returned.
 
void SetProperty (string key, string content)
 Sets the value of a property (all is string format here)
 
override string ToString ()
 Display the 'DisplayName' is the default ToString()
 

Properties

ArchiveStorageFolder ArchiveStorageFolder [get]
 Return the single folder item of the given ItemType.
 
DateTime CreatedDate [get]
 Created date.
 
string DiskPath [get]
 Path. Contains the path to the storage disk.
 
String EncryptionMethod [get]
 Encryption. Specifies the strength of the encryption. Valid values are available in the EncryptionMethodValues property dictionary.
 
Dictionary< string, string > EncryptionMethodValues [get]
 A list of valid names/values for the EncryptionMethod property.
 
string Id [get]
 ID.
 
bool IsDefault [get]
 Default storage. Is default.
 
DateTime LastModified [get]
 Last modified.
 
int MaxSize [get, set]
 Max size (in MB). The maximum size of the recording storage in MB. The value have to be between 1 and 1099511627776 (1 exabyte). By default, the value is set to 1024, which is 1 GB.
 
int RetainMinutes [get, set]
 Retention time. The number of minutes that must elapse before data are deleted or archived. The value that specifies the retention period in minutes. The value have to be between 1 and 525600000 (365000 days). By default, the value is 1440, which is 1 day.
 
bool Signing [get, set]
 Signing. Specifies if database should be signed.
 
- Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem
Guid Guid [get]
 Returns the id property or part of the path, when available. When no id is available this will be Guid.Empty. This is relevant for some items of ItemCategory.ChildItem where no property with key = "Id" exists and path does not contains a guid.
 
Collection< string > Methods [get]
 The available methods for this class.
 
- Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem
string Description [get, set]
 Description.
 
virtual string DisplayName [get]
 Name of this ConfigurationItem in user readable format. Usually the same as property with key = "Name".
 
string ItemCategory [get]
 Return the item category for this item. This can be used to understand how multiple items are fetched and saved together. Only ItemCategory == 'Item' can be saved.
 
string Name [get, set]
 Name.
 
string ParentItemPath [get]
 Get hold of the next real parent path, e.g. skip any 'Folder' type parent.
 
string ParentPath [get]
 The path for the parent of this ConfigurationItem.
 
string Path [get]
 The identification of this item.

 
ServerId ServerId [get, set]
 Contains the ServerId of the Management Server holding this item.
 

Detailed Description

Constructor & Destructor Documentation

◆ Storage() [1/3]

VideoOS.Platform.ConfigurationItems.Storage.Storage ( ServerId serverId,
ConfigurationItem storage )
inline

Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem.

Parameters
serverIdIdentify the Management Server that owns the configuration
storageThe ConfigurationItem returned from elsewhere
Exceptions
ArgumentMIPExceptionWhen LoginSettings not found for serverId

◆ Storage() [2/3]

VideoOS.Platform.ConfigurationItems.Storage.Storage ( ServerId serverId,
string path )
inline

Construct the class from serverId of the Management Server that owns the configuration, and the path of the item.

This construction will contact the server and read the specified item.

Parameters
serverIdIdentify the Management Server that owns the configuration
pathThe path of a specific item
Exceptions
MIPExceptionRepresents a number of possible exceptions. Possible exceptions can be found via the inherited exceptions - like PathNotFoundMIPException

◆ Storage() [3/3]

VideoOS.Platform.ConfigurationItems.Storage.Storage ( FQID fqid)
inline

Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID.

This construction will contact the server and read the specified item.

Parameters
fqidIdentify the MIP item
Exceptions
MIPExceptionRepresents a number of possible exceptions. Possible exceptions can be found via the inherited exceptions - like PathNotFoundMIPException

Member Function Documentation

◆ ChangeEncryptionMethod() [1/2]

ChangeEncryptionMethodServerTask VideoOS.Platform.ConfigurationItems.Storage.ChangeEncryptionMethod ( )
inline

Change encryption method.

◆ ChangeEncryptionMethod() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.Storage.ChangeEncryptionMethod ( String encryptionMethod,
System.Security.SecureString password )
inline

Change encryption method.

Parameters
encryptionMethodEncryption. Specifies the strength of the encryption
passwordEncryption password. Encryption password for recording storage

◆ ChangePasswordStorageEncryption() [1/2]

ChangePasswordStorageEncryptionServerTask VideoOS.Platform.ConfigurationItems.Storage.ChangePasswordStorageEncryption ( )
inline

Change encryption password for recording storage.

◆ ChangePasswordStorageEncryption() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.Storage.ChangePasswordStorageEncryption ( String oldPassword,
String newPassword )
inline

Change encryption password for recording storage.

Parameters
oldPasswordOld encryption password. The old encryption password for recording storage
newPasswordNew encryption password. New encryption password for recording storage

◆ DisableEncryption() [1/2]

DisableEncryptionServerTask VideoOS.Platform.ConfigurationItems.Storage.DisableEncryption ( )
inline

Disable encryption on recording storage.

◆ DisableEncryption() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.Storage.DisableEncryption ( System.Security.SecureString password)
inline

Disable encryption on recording storage.

Parameters
passwordEncryption password. Encryption password for recording storage

◆ EnableEncryption() [1/3]

EnableEncryptionServerTask VideoOS.Platform.ConfigurationItems.Storage.EnableEncryption ( )
inline

Enable encryption on recording storage.

◆ EnableEncryption() [2/3]

ServerTask VideoOS.Platform.ConfigurationItems.Storage.EnableEncryption ( String password,
String encryptionMethod )
inline

Enable encryption on recording storage
Please consider using secure version taking SecureString instead.

Parameters
passwordEncryption password
encryptionMethodEncryption

◆ EnableEncryption() [3/3]

ServerTask VideoOS.Platform.ConfigurationItems.Storage.EnableEncryption ( System.Security.SecureString password,
String encryptionMethod )
inline

Enable encryption on recording storage.

Parameters
passwordEncryption password. Encryption password for recording storage
encryptionMethodEncryption. Specifies the strength of the encryption

◆ GetDevicesUsingStorage()

ClassCollectionServerTask VideoOS.Platform.ConfigurationItems.Storage.GetDevicesUsingStorage ( )
inline

Get devices using this storage.

◆ MoveRecordingStorage() [1/2]

MoveRecordingStorageServerTask VideoOS.Platform.ConfigurationItems.Storage.MoveRecordingStorage ( )
inline

Move storage.

◆ MoveRecordingStorage() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.Storage.MoveRecordingStorage ( String diskPath)
inline

Move storage.

Parameters
diskPathPath. Contains the path to the storage disk

◆ ReadStorageInformation()

ServerTask VideoOS.Platform.ConfigurationItems.Storage.ReadStorageInformation ( )
inline

Read storage information.

◆ SetStorageAsDefault()

ServerTask VideoOS.Platform.ConfigurationItems.Storage.SetStorageAsDefault ( )
inline

Set storage as default.

◆ ValidateStorageEncryptionPassword() [1/2]

ValidateStorageEncryptionPasswordServerTask VideoOS.Platform.ConfigurationItems.Storage.ValidateStorageEncryptionPassword ( )
inline

Validate encryption password on recording storage.

◆ ValidateStorageEncryptionPassword() [2/2]

ServerTask VideoOS.Platform.ConfigurationItems.Storage.ValidateStorageEncryptionPassword ( System.Security.SecureString password)
inline

Validate encryption password on recording storage.

Parameters
passwordEncryption password. Encryption password for recording storage

Property Documentation

◆ ArchiveStorageFolder

ArchiveStorageFolder VideoOS.Platform.ConfigurationItems.Storage.ArchiveStorageFolder
get

Return the single folder item of the given ItemType.

◆ CreatedDate

DateTime VideoOS.Platform.ConfigurationItems.Storage.CreatedDate
get

Created date.

◆ DiskPath

string VideoOS.Platform.ConfigurationItems.Storage.DiskPath
get

Path. Contains the path to the storage disk.

◆ EncryptionMethod

String VideoOS.Platform.ConfigurationItems.Storage.EncryptionMethod
get

Encryption. Specifies the strength of the encryption. Valid values are available in the EncryptionMethodValues property dictionary.

◆ EncryptionMethodValues

Dictionary<string, string> VideoOS.Platform.ConfigurationItems.Storage.EncryptionMethodValues
get

A list of valid names/values for the EncryptionMethod property.

◆ Id

string VideoOS.Platform.ConfigurationItems.Storage.Id
get

ID.

◆ IsDefault

bool VideoOS.Platform.ConfigurationItems.Storage.IsDefault
get

Default storage. Is default.

◆ LastModified

DateTime VideoOS.Platform.ConfigurationItems.Storage.LastModified
get

Last modified.

◆ MaxSize

int VideoOS.Platform.ConfigurationItems.Storage.MaxSize
getset

Max size (in MB). The maximum size of the recording storage in MB. The value have to be between 1 and 1099511627776 (1 exabyte). By default, the value is set to 1024, which is 1 GB.

◆ RetainMinutes

int VideoOS.Platform.ConfigurationItems.Storage.RetainMinutes
getset

Retention time. The number of minutes that must elapse before data are deleted or archived. The value that specifies the retention period in minutes. The value have to be between 1 and 525600000 (365000 days). By default, the value is 1440, which is 1 day.

◆ Signing

bool VideoOS.Platform.ConfigurationItems.Storage.Signing
getset

Signing. Specifies if database should be signed.