DoconutOptions
Configura i servizi Doconut
DoconutOptions (namespace Doconut) è l'oggetto di configurazione unico per l'intero SDK. Lo configuri una volta, all'interno di AddDoconut(), ed è registrato come singleton.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.UnsafeMode = false;
options.ShowDoconutInfo = false;
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Proprietà
| Tipo | Proprietà | Predefinito | Descrizione |
|---|---|---|---|
bool | ShowDoconutInfo | false | Quando true, una richiesta middleware senza token restituisce un banner di versione (Doconut <version> is running on <host>) invece di 404. Utile come verifica rapida; lascia false in produzione. |
bool | UnsafeMode | false | Quando true, salta il controllo di sicurezza della sessione ASP.NET nelle richieste di pagina. Lascia false in produzione (vedi Concetti Base → Sessioni e Sicurezza). |
string | MiddlewarePath | "/doconut" | Valore di coordinazione per l'endpoint page-image. Viene validato, ma non monta un ramo della pipeline; mantienilo allineato con la mappatura reale UseDoconut() e il client BasePath. |
string | ResourcesPath | "/doconut-res" | Prefisso del percorso URL per le risorse JS/CSS/immagine/font incorporate. |
string | LicensePath | "" | Percorso al file di licenza. Vuoto → fonte di licenza successiva, poi scoperta automatica; se non trovato → stato di valutazione con filigrana senza funzionalità. |
string | LicenseContent | "" | Contenuto XML grezzo della licenza (database, variabile d'ambiente, gestore segreti). Ha precedenza su LicensePath. |
Stream? | LicenseStream | null | Licenza come stream, letta una volta all'avvio. Ha precedenza su entrambe le altre fonti. |
bool | ResetLicense | false | Flag di compatibilità riservata. L'attuale implementazione .NET 8 non la utilizza; riavvia l'applicazione dopo aver sostituito una licenza. |
DoconutPluginRegistry | PluginRegistry | — | Registro di sola lettura che raccoglie i contributi dei plugin; consumato dalla factory del visualizzatore. Popola tramite AddPlugin<T>(). |
Priorità delle licenze (applicata alla registrazione del servizio): LicenseStream → LicenseContent → LicensePath → scoperta automatica (vedi Guida introduttiva → Configurazione licenza).
Metodi
AddPlugin<TPlugin>()
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()Usa questo metodo per i pacchetti Converter, DICOM e Signer rilasciati con opt-in. L'annotazione e la ricerca normale sono funzionalità con licenza integrate e non utilizzano AddPlugin<TPlugin>().
Registra un plugin di prima parte (Converter, DICOM, Signer). Fluent — restituisce l'istanza delle opzioni. AddDoconut() genera InvalidOperationException per una licenza mancante, file legacy TRIAL, o licenza a pagamento che non concede la capacità del plugin. Le registrazioni temporanee/Demo sono mantenute oltre la scadenza e diventano soggette al filtro di runtime (vedi Concetti Base → Sistema dei Plugin).
Il widget Converter con opt-in è abilitato con AddConverterWidget() e reso disponibile tramite la proprietà di sola lettura ConverterWidget; le sue opzioni sono documentate nella pagina del plugin Converter (Plugin → Plugin Converter). Il widget Signer con opt-in è abilitato allo stesso modo, con AddSignerWidget(), e reso disponibile tramite la proprietà di sola lettura SignerWidget; vedi Plugin Signer.
RegisterViewer(extension, factory, defaultConfig?)
DoconutOptions RegisterViewer(
string extension, // ".myext" — punto iniziale facoltativo
Func<IFormatViewer> factory,
Func<BaseConfig>? defaultConfig = null)Registra un visualizzatore personalizzato per un'estensione di file. I visualizzatori personalizzati hanno precedenza sui visualizzatori integrati e sui plugin e non sono soggetti a licenza. Quando defaultConfig è omesso e un documento si apre senza una configurazione esplicita, viene usato un ImageConfig.
Genera ArgumentException (Extension must be a non-empty file extension.) per un'estensione vuota e ArgumentNullException per una factory nulla.
Convalida all'avvio
AddDoconut() convalida le opzioni fail-fast, così una configurazione errata appare come un'eccezione chiara all'avvio invece di 404 confusi al momento della richiesta:
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.Configurazioni comuni
// Produzione: licenza esplicita, tutto bloccato (tutte le impostazioni di sicurezza predefinite)
builder.Services.AddDoconut(options =>
{
options.LicenseContent = builder.Configuration["Doconut:License"] ?? "";
});
// Percorsi personalizzati (es. per evitare un conflitto di route)
builder.Services.AddDoconut(options =>
{
options.MiddlewarePath = "/docs-engine";
options.ResourcesPath = "/docs-assets";
});Quando cambi ResourcesPath, mantieni sincronizzato il ResPath del widget client (vedi ViewerConfig).
MiddlewarePath non è un mapper di route automatico per ASP.NET Core. Se Doconut deve rispondere solo sotto un prefisso personalizzato, monta UseDoconut() su quel ramo (ad esempio con app.Map("/docs-engine", branch => branch.UseDoconut())) e imposta il client BasePath su quel prefisso senza il / iniziale ('docs-engine').
Questa pagina è stata utile?