Class RelayStateCache

Provides a cache for storing RelayState.

Inheritance

object

RelayStateCache

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Bindings

Assembly: ComponentSpace.Saml2.dll

Syntax

public static class RelayStateCache

Remarks

The cache is implemented using the System.Web.Caching.Cache. Use of this cache is entirely optional. Refer to the System.Web.Caching.Cache documentation for usage restrictions.

Properties

Expiration

Gets or sets the expiration time span for cached relay state entries.

Declaration

public static TimeSpan Expiration { get; set; }

Property Value

Type	Description
TimeSpan	The expiration time span for cached relay state entries.

Methods

Add(RelayState)

Adds an entry to the cache and returns the key to this entry.

Declaration

public static string Add(RelayState relayState)

Parameters

Type	Name	Description
RelayState	relayState	The item to cache.

Returns

Type	Description
string	The key to this entry in the cache.

Get(string)

Gets an entry from the cache.

Declaration

public static RelayState Get(string key)

Parameters

Type	Name	Description
string	key	The key to the cache item to remove.

Returns

Type	Description
RelayState	The cached item or null if none.

Remove(string)

Removes an entry from the cache.

Declaration

public static RelayState Remove(string key)

Parameters

Type	Name	Description
string	key	The key to the cache item to remove.

Returns

Type	Description
RelayState	The item removed from the cache or null if none.