SAPTeam.EasySign.Manifest Class Reference

Represents a manifest that holds entries of file names and their corresponding hashes. More...

Public Member Functions
ConcurrentDictionary< string, byte[]>	GetEntries ()
	Gets the entries as a thread-safe concurrent dictionary.
void	AddEntry (string entryName, byte[] hash)
	Adds an entry to the manifest.
void	DeleteEntry (string entryName)
	Deletes an entry from the manifest.

Static Public Member Functions
static string	GetNormalizedEntryName (string path)
	Converts the path to an standard zip entry name.

Properties
string?	UpdatedBy [get, set]
	Gets or sets the full name of the class that updated the manifest.
SortedDictionary< string, byte[]>	Entries [get, set]
	Gets or sets the entries in the manifest as a sorted dictionary.
bool	StoreOriginalFiles [get, set]
	Gets or sets a value indicating whether the files should be stored in the bundle.
HashSet< string >	ProtectedEntryNames = [] [get, set]
	Gets or sets the list of entry names that should be protected by the bundle from accidental modifications.

Detailed Description

Represents a manifest that holds entries of file names and their corresponding hashes.

Definition at line 10 of file Manifest.cs.

Member Function Documentation

AddEntry()

void SAPTeam.EasySign.Manifest.AddEntry	(	string	entryName,
		byte[]	hash )

Adds an entry to the manifest.

An exception will be thrown if the entry already exists.

Parameters

entryName	The name of the entry to add.
hash	The hash of the entry to add.

Exceptions

DuplicateNameException

Definition at line 58 of file Manifest.cs.

Referenced by SAPTeam.EasySign.Bundle.AddEntry().

DeleteEntry()

void SAPTeam.EasySign.Manifest.DeleteEntry

(

string

entryName

)

Deletes an entry from the manifest.

An exception will be thrown if the entry does not exist.

Parameters

entryName

The name of the entry to delete.

Exceptions

KeyNotFoundException

Definition at line 72 of file Manifest.cs.

Referenced by SAPTeam.EasySign.Bundle.DeleteEntry().

GetEntries()

ConcurrentDictionary< string, byte[]> SAPTeam.EasySign.Manifest.GetEntries

(

)

Gets the entries as a thread-safe concurrent dictionary.

Returns

A concurrent dictionary containing the entries.

Referenced by SAPTeam.EasySign.Bundle.VerifyFile().

GetNormalizedEntryName()

static string SAPTeam.EasySign.Manifest.GetNormalizedEntryName ( string path )

static

Converts the path to an standard zip entry name.

Parameters

path	The path to convert.

Returns

The normalized entry name.

Referenced by SAPTeam.EasySign.Bundle.AddEntry(), and SAPTeam.EasySign.CommandLine.CommandProvider< TBundle, TConfiguration >.RunAdd().

Property Documentation

Entries

SortedDictionary<string, byte[]> SAPTeam.EasySign.Manifest.Entries

getset

Gets or sets the entries in the manifest as a sorted dictionary.

Note that this property is only for serialization purposes. Use GetEntries to get the entries as a concurrent dictionary. you can use this property to get a copy of the entries as a sorted dictionary but any changes made to it will be ignored.

Definition at line 26 of file Manifest.cs.

Referenced by SAPTeam.EasySign.CommandLine.CommandProvider< TBundle, TConfiguration >.RunAdd(), SAPTeam.EasySign.CommandLine.CommandProvider< TBundle, TConfiguration >.RunInfo(), and SAPTeam.EasySign.CommandLine.CommandProvider< TBundle, TConfiguration >.RunVerify().

ProtectedEntryNames

HashSet<string> SAPTeam.EasySign.Manifest.ProtectedEntryNames = []

getset

Gets or sets the list of entry names that should be protected by the bundle from accidental modifications.

Definition at line 39 of file Manifest.cs.

Referenced by SAPTeam.EasySign.Bundle.GetManifestData(), SAPTeam.EasySign.Bundle.Parse(), and SAPTeam.EasySign.CommandLine.CommandProvider< TBundle, TConfiguration >.RunInfo().

StoreOriginalFiles

bool SAPTeam.EasySign.Manifest.StoreOriginalFiles

getset

Gets or sets a value indicating whether the files should be stored in the bundle.

Definition at line 34 of file Manifest.cs.

Referenced by SAPTeam.EasySign.Bundle.AddEntry(), SAPTeam.EasySign.Bundle.DeleteEntry(), and SAPTeam.EasySign.CommandLine.CommandProvider< TBundle, TConfiguration >.RunInfo().

UpdatedBy

string? SAPTeam.EasySign.Manifest.UpdatedBy

getset

Gets or sets the full name of the class that updated the manifest.

Definition at line 17 of file Manifest.cs.

Referenced by SAPTeam.EasySign.CommandLine.CommandProvider< TBundle, TConfiguration >.LoadBundle(), and SAPTeam.EasySign.CommandLine.CommandProvider< TBundle, TConfiguration >.RunInfo().

---

The documentation for this class was generated from the following file:

• Manifest.cs