Classe FileHandler

Interfaccia per tutte le funzioni di gestione dei file.

Riepilogo

Membri Descrizione
public std::shared_ptr<ContentLabel> GetLabel() Avvia il recupero dell'etichetta di riservatezza dal file.
public std::vector<std::p air<std::string, std::string>> GetProperties(uint32_t version) Recupera le proprietà del file in base alla versione.
public std::shared_ptr<ProtectionHandler> GetProtection() Avvia il recupero dei criteri di protezione dal file.
public void RegisterContentForTrackingAndRevocationAsync(bool isOwnerNotificationEnabled, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Registrare il contenuto per il rilevamento e la revoca.
public void RevokeContentAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Eseguire la revoca per il contenuto.
public void ClassifyAsync(const std::shared_ptr<void>& context) Esegue le regole nel gestore e restituisce l'elenco di azioni da eseguire.
public void InspectAsync(const std::shared_ptr<void>& context) Creare un oggetto controllo file, usato per recuperare il contenuto del file da formati di file compatibili.
public void SetLabel(const std::shared_ptr<Label& label>, const LabelingOptions& labelingOptions, const Protection Impostazioni& protection Impostazioni) Imposta l'etichetta di riservatezza sul file.
public void DeleteLabel(const LabelingOptions& labelingOptions) Elimina l'etichetta di riservatezza dal file.
public void SetProtection(const std::shared_ptr<ProtectionDescriptor& protectionDescriptor>, const Protection Impostazioni& protection Impostazioni) Imposta le autorizzazioni personalizzate o basate su modello (in base a protectionDescriptor-GetProtectionType>) sul file.
public void SetProtection(const std::shared_ptr<ProtectionHandler>& protectionHandler) Imposta la protezione su un documento usando un gestore di protezione esistente.
public void RemoveProtection() Rimuove la protezione dal file. Se il formato di file originale non supporta l'etichettatura, l'etichetta andrà persa quando viene rimossa la protezione. Quando il formato nativo supporta l'etichettatura, i metadati dell'etichetta vengono mantenuti.
public void CommitAsync(const std::string& outputFilePath, const std::shared_ptr<void>& context) Scrive le modifiche nel file specificato dal parametro outputFilePath.
public void CommitAsync(const std::shared_ptr<Stream>& outputStream, const std::shared_ptr<void>& context) Scrive le modifiche nel flusso specificato dal parametro outputStream.
public bool IsModified() Controlla se sono presenti modifiche da eseguire per il commit nel file.
public void GetDecryptedTemporaryFileAsync(const std::shared_ptr<void>& context) Restituisce un percorso di un file temporaneo che verrà eliminato, se possibile, che rappresenta il contenuto decrittografato.
public void GetDecryptedTemporaryStreamAsync(const std::shared_ptr<void>& context) Restituisce un flusso che rappresenta il contenuto decrittografato.
public void NotifyCommitSuccessful(const std::string& actualFilePath) Per essere chiamato quando è stato eseguito il commit delle modifiche sul disco.
public std::string GetOutputFileName() Calcola il nome e l'estensione del file di output in base al nome file originale e alle modifiche accumulate.

Membri

Funzione GetLabel

Avvia il recupero dell'etichetta di riservatezza dal file.

Eccezioni

  • NotSupportedError: quando un motore di sola protezione è in uso e non viene trovato alcun gestore dei criteri.

Funzione GetProperties

Recupera le proprietà del file in base alla versione.

Funzione GetProtection

Avvia il recupero dei criteri di protezione dal file.

Funzione RegisterContentForTrackingAndRevocationAsync

Registrare il contenuto per il rilevamento e la revoca.

Parametri:

  • isOwnerNotificationEnabled: impostare su true per notificare al proprietario tramite posta elettronica ogni volta che il documento viene decrittografato o false per non inviare la notifica.

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono.

Funzione RevokeContentAsync

Eseguire la revoca per il contenuto.

Parametri:

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono.

Funzione ClassifyAsync

Esegue le regole nel gestore e restituisce l'elenco di azioni da eseguire.

Restituisce: elenco di azioni che devono essere applicate al contenuto.

Eccezioni

  • NotSupportedError: quando un motore di sola protezione è in uso e non viene trovato alcun gestore dei criteri.

Funzione InspectAsync

Creare un oggetto controllo file, usato per recuperare il contenuto del file da formati di file compatibili.

Restituisce: controllo file.

Funzione SetLabel

Imposta l'etichetta di riservatezza sul file. Le modifiche non verranno scritte nel file finché non viene chiamato CommitAsync. Il metodo Privileged e Auto consente all'API di eseguire l'override di qualsiasi etichetta esistente Throws JustificationRequiredError quando si imposta l'etichetta richiede che l'operazione sia giustificato (tramite il parametro labelingOptions).

Eccezioni

  • NotSupportedError: quando un motore di sola protezione è in uso e non viene trovato alcun gestore dei criteri.

Funzione DeleteLabel

Elimina l'etichetta di riservatezza dal file. Le modifiche non verranno scritte nel file finché non viene chiamato CommitAsync. Il metodo Privileged e Auto consente all'API di eseguire l'override di qualsiasi etichetta esistente Throws JustificationRequiredError quando si imposta l'etichetta richiede che l'operazione sia giustificato (tramite il parametro labelingOptions).

Eccezioni

  • NotSupportedError: quando un motore di sola protezione è in uso e non viene trovato alcun gestore dei criteri.

Funzione SetProtection

Imposta le autorizzazioni personalizzate o basate su modello (in base a protectionDescriptor-GetProtectionType>) sul file. Le modifiche non verranno scritte nel file finché non viene chiamato CommitAsync.

Funzione SetProtection

Imposta la protezione su un documento usando un gestore di protezione esistente. Le modifiche non verranno scritte nel file finché non viene chiamato CommitAsync.

Funzione RemoveProtection

Rimuove la protezione dal file. Se il formato di file originale non supporta l'etichettatura, l'etichetta andrà persa quando viene rimossa la protezione. Quando il formato nativo supporta l'etichettatura, i metadati dell'etichetta vengono mantenuti. Le modifiche non verranno scritte nel file finché non viene chiamato CommitAsync.

Funzione CommitAsync

Scrive le modifiche apportate al file specificato da |outputFilePath| Parametro. FileHandler::Observer verrà chiamato in caso di esito positivo o negativo. Se lo spazio su disco del file di output non è sufficiente, la funzione FileHandler::CommitAsync potrebbe generare file danneggiati. In questo caso, eliminare i file danneggiati e regolare le dimensioni del disco o scegliere un altro disco prima di ritentare l'operazione.

Funzione CommitAsync

Scrive le modifiche nel flusso specificato da |outputStream| Parametro. |outputStream| non deve essere uguale a inputStream usato per la creazione del gestore. FileHandler::Observer verrà chiamato in caso di esito positivo o negativo. Se lo spazio su disco del file di output non è sufficiente, la funzione FileHandler::CommitAsync potrebbe generare file danneggiati. In questo caso, eliminare i file danneggiati e regolare le dimensioni del disco o scegliere un altro disco prima di ritentare l'operazione.

Funzione IsModified

Controlla se sono presenti modifiche da eseguire per il commit nel file. Le modifiche non verranno scritte nel file finché non viene chiamato CommitAsync.

Funzione GetDecryptedTemporaryFileAsync

Restituisce un percorso di un file temporaneo che verrà eliminato, se possibile, che rappresenta il contenuto decrittografato. FileHandler::Observer verrà chiamato in caso di esito positivo o negativo.

Funzione GetDecryptedTemporaryStreamAsync

Restituisce un flusso che rappresenta il contenuto decrittografato. FileHandler::Observer verrà chiamato in caso di esito positivo o negativo.

Funzione NotifyCommitSuccessful

Per essere chiamato quando è stato eseguito il commit delle modifiche sul disco.

Parametri:

  • actualFilePath: percorso effettivo del file di output

Genera un evento Audit

Eccezioni

  • NotSupportedError: quando un motore di sola protezione è in uso e non viene trovato alcun gestore dei criteri.

Funzione GetOutputFileName

Calcola il nome e l'estensione del file di output in base al nome file originale e alle modifiche accumulate.