Class DataBlockServerOptions

Namespace

Datafication.Server.Core.Configuration

Assembly

Datafication.Server.Core.dll

Configuration options for the DataBlock Server.

public class DataBlockServerOptions

Inheritance

object

DataBlockServerOptions

Properties

AccessPolicies

Gets or sets custom access policies mapped to their requirements.

public IDictionary<string, string[]> AccessPolicies { get; set; }

Property Value

IDictionary<string, string[]>

AllowAnonymousAccess

Gets or sets a value indicating whether anonymous access is allowed.

public bool AllowAnonymousAccess { get; set; }

Property Value

bool

CacheDurationSeconds

Gets or sets the cache duration in seconds for DataBlock responses.

public int CacheDurationSeconds { get; set; }

Property Value

int

DefaultAccessPolicy

Gets or sets the default access policy for DataBlocks.

public string DefaultAccessPolicy { get; set; }

Property Value

string

EnableCaching

Gets or sets a value indicating whether caching is enabled for DataBlock responses.

public bool EnableCaching { get; set; }

Property Value

bool

IncludeDetailedErrors

Gets or sets a value indicating whether detailed error messages are returned.

public bool IncludeDetailedErrors { get; set; }

Property Value

bool

MaxRegisteredDataBlocks

Gets or sets the maximum number of DataBlocks that can be registered.

public int MaxRegisteredDataBlocks { get; set; }

Property Value

int

MaxRowsPerRequest

Gets or sets the maximum number of rows to return in a single request.

public int MaxRowsPerRequest { get; set; }

Property Value

int

RegisteredConnectors

Gets or sets the registered connector factories with their configuration types.

public IDictionary<string, (Type FactoryType, Type ConfigurationType)> RegisteredConnectors { get; set; }

Property Value

IDictionary<string, (Type FactoryType, Type ConfigurationType)>

RegisteredSinks

Gets or sets the registered sink types.

public IDictionary<string, Type> RegisteredSinks { get; set; }

Property Value

IDictionary<string, Type>

RegistryImplementationType

Gets or sets the registry implementation type to use.

public Type? RegistryImplementationType { get; set; }

Property Value

Type

RoutePrefix

Gets or sets the API route prefix.

public string RoutePrefix { get; set; }

Property Value

string

SupportedOutputFormats

Gets or sets the supported output formats for DataBlock responses.

public IEnumerable<string> SupportedOutputFormats { get; set; }

Property Value

IEnumerable<string>

Methods

RegisterConnector<TFactory, TConfiguration>(string)

Registers a connector factory for the specified connector type.

public DataBlockServerOptions RegisterConnector<TFactory, TConfiguration>(string connectorType) where TFactory : class where TConfiguration : class

Parameters

connectorType string

The identifier for the connector type (e.g., "csv", "excel").

Returns

DataBlockServerOptions

The options instance for method chaining.

Type Parameters

TFactory

The type of the connector factory.

TConfiguration

The type of the connector configuration.

RegisterSink<TSink>(string)

Registers a sink type for the specified sink identifier.

public DataBlockServerOptions RegisterSink<TSink>(string sinkKey) where TSink : class

Parameters

sinkKey string

The identifier for the sink type (e.g., "pdf", "excel").

Returns

DataBlockServerOptions

The options instance for method chaining.

Type Parameters

TSink

The type of the sink.