RepositoryPathHelper Class

Provides methods for working with file paths in file system repository.

Inheritance Hierarchy

System.Object
  CMS.ContinuousIntegration.Internal.RepositoryPathHelper

Namespace: CMS.ContinuousIntegration.Internal
Assembly: CMS.ContinuousIntegration (in CMS.ContinuousIntegration.dll) Version: 11.0.0

Syntax

public class RepositoryPathHelper

The RepositoryPathHelper type exposes the following members.

Constructors

	Name	Description
Public method	RepositoryPathHelper	Constructor

Fields

	Name	Description
Public field Static member	FILE_NAME_HASH_LENGTH	Length of hash used when appending regular file name with a hash. The file name's length is truncated to (MAX_FILE_NAME_LENGTH - FILE_NAME_HASH_LENGTH - 1). One character is needed for delimiter. It is assumed that portion of hash is unique enough to avoid collisions.
Public field Static member	GROUP_FILE_NAME_HASH_LENGTH	Length of hash used when appending group file name with a hash. The file name's length is truncated to (MAX_GROUP_FILE_NAME_LENGTH - GROUP_FILE_NAME_HASH_LENGTH - 1). One character is needed for delimiter. It is assumed that portion of hash is unique enough to avoid collisions.
Public field Static member	GROUP_FOLDER_SUFFIX_HASH_LENGTH	Length of hash used when appending group folder suffix with a hash. The suffix's length is truncated to (MAX_GROUP_FOLDER_SUFFIX_LENGTH - GROUP_FOLDER_SUFFIX_HASH_LENGTH - 1). One character is needed for delimiter. It is assumed that portion of hash is unique enough to avoid collisions.
Protected field Static member	GROUP_SUFFIX_DELIMITER	Delimiter between hashed name and group suffix (used when creating name of folder for grouped files).
Public field Static member	MAX_FILE_NAME_LENGTH	Maximum length of regular file name (without extension).
Public field Static member	MAX_GROUP_FILE_NAME_LENGTH	Maximum length of group file name (without extension).
Public field Static member	MAX_GROUP_FOLDER_SUFFIX_LENGTH	Maximum length of group folder suffix.
Protected field	mRepositoryConfiguration	Configuration of a file system repository.
Protected field	mTranslationHelper	Translation helper object. Used in serialization to optimize database calls.

Methods

	Name	Description
Public method	GetExistingSerializationFiles	Gets relative paths to the serialization files of given baseInfo stored in repository.
Public method	GetFileName	Gets name of the file where serialized baseInfo will be stored.
Public method	GetFilePath(BaseInfo)	Gets relative path to file where serialized baseInfo is to be stored (within the file system repository).
Public method	GetFilePath(BaseInfo, String, String, Boolean)	Gets relative path to group file where serialized data are to be stored (within the file system repository). A group of files is used when serializing one base info to multiple files.
Public method	GetGroupFileName	Gets name of the group file from desiredGroupFileName. Group file name is transformed in order to contain file system safe characters. The group file name is at most MAX_GROUP_FILE_NAME_LENGTH characters in length.
Public method	GetGroupFolderSuffix	Gets file system safe representation of group suffix (without the GROUP_SUFFIX_DELIMITER). The group folder suffix is at most MAX_GROUP_FOLDER_SUFFIX_LENGTH long.
Public method	GetPathWithoutExtension	Gets path without the file extension.
Public method	GetRelativeFolderPath	Gets relative path to folder where serialized baseInfo is to be stored.
Public method	GetSeparatedFieldPath(String, String)	Gets relative path without extension to separated field file where field's data are to be stored (within the file system repository).
Public method	GetSeparatedFieldPath(BaseInfo, String, SeparatedField)	Gets relative path of separate field's file.
Public method	GetSerializationFileExtension	Gets file extension (including the '.' character) of a file in repository identified by its relative path without extension.