Class ContentBasedObjectResultOptions<T>

Namespace

Cuemon.AspNetCore.Mvc

Assembly

Cuemon.AspNetCore.Mvc.dll

Specifies options that is related to the ICacheableObjectResult interface.

public class ContentBasedObjectResultOptions<T> : IContentBasedObjectResultOptions<T>, IValidatableParameterObject, IParameterObject

Type Parameters

T

Inheritance

object

ContentBasedObjectResultOptions<T>

Implements

IContentBasedObjectResultOptions<T>

IValidatableParameterObject

IParameterObject

Examples

The following example demonstrates how to configure to provide a checksum provider for generating ETags.

using System;
using System.Security.Cryptography;
using System.Text;
using Cuemon.AspNetCore.Mvc;

namespace MyApp.Examples;

public class ContentBasedObjectResultOptionsExample
{
    public void Demonstrate()
    {
        var options = new ContentBasedObjectResultOptions<string>
        {
            ChecksumProvider = value => SHA256.HashData(Encoding.UTF8.GetBytes(value)),
            WeakChecksumProvider = _ => false // use strong ETag
        };

        // Validate that the required properties are configured
        options.ValidateOptions();

        Console.WriteLine("ChecksumProvider is configured.");

}
}

Constructors

ContentBasedObjectResultOptions()

Initializes a new instance of the ContentBasedObjectResultOptions<T> class.

public ContentBasedObjectResultOptions()

Properties

ChecksumProvider

Gets or sets the function delegate that resolves a checksum defining the data integrity of the specified T.

public Func<T, byte[]> ChecksumProvider { get; set; }

Property Value

Func<T, byte[]>

The function delegate that resolves a checksum defining the data integrity of the specified T.

WeakChecksumProvider

Gets or sets the function delegate that resolves a value hinting whether the specified ChecksumProvider resembles a weak or a strong checksum strength.

public Func<T, bool> WeakChecksumProvider { get; set; }

Property Value

Func<T, bool>

The function delegate that resolves a value hinting whether the specified ChecksumProvider resembles a weak or a strong checksum strength.

Methods

ValidateOptions()

Determines whether the public read-write properties of this instance are in a valid state.

public void ValidateOptions()

Remarks

This method is expected to throw exceptions when one or more conditions fails to be in a valid state.

Exceptions

InvalidOperationException

ChecksumProvider cannot be null.

See Also

CacheableFactory

IValidatableParameterObject