Class DistributedArtifactCache

Namespace

ComponentSpace.Saml2.Cache

Assembly

ComponentSpace.Saml2.dll

The distributed artifact cache stores artifacts in a distributed cache.

The distributed artifact cache is suitable for applications deployed to a web farm.

public class DistributedArtifactCache : IArtifactCache

Inheritance

object

DistributedArtifactCache

Implements

IArtifactCache

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DistributedArtifactCache(IDistributedCache, ILoggerFactory)

Initializes a new instance of the DistributedArtifactCache class.

public DistributedArtifactCache(IDistributedCache distributedCache, ILoggerFactory loggerFactory)

Parameters

distributedCache IDistributedCache

The distributed cache used to store artifacts.

loggerFactory ILoggerFactory

The logger factory.

Methods

AddAsync(string, string, DateTime)

Adds the artifact and associated state to the cache.

public Task AddAsync(string artifact, string artifactState, DateTime expirationDateTime)

Parameters

artifact string

The artifact.

artifactState string

The artifact state.

expirationDateTime DateTime

The expiration time.

Returns

Task

Exceptions

SamlEnvironmentException

Thrown if the artifact cannot be added to the cache.

RemoveAsync(string)

Removes the artifact from the cache.

public Task<string> RemoveAsync(string artifact)

Parameters

artifact string

The artifact.

Returns

Task<string>

A task that represents the remove operation and returns the associated artifact state.

Exceptions

SamlEnvironmentException

Thrown if the artifact cannot be removed from the cache.