Interface IArtifactCache
The artifact cache manages artifacts and associated state.
Namespace: ComponentSpace.Saml2.Cache
Assembly: ComponentSpace.Saml2.dll
Syntax
public interface IArtifactCacheMethods
AddAsync(String, String, DateTime)
Adds the artifact and associated SAML message to the cache.
Declaration
Task AddAsync(string artifact, string artifactState, DateTime expirationDateTime)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | artifact | The artifact. |
| System.String | artifactState | The artifact state. |
| System.DateTime | expirationDateTime | The expiration time. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Exceptions
| Type | Condition |
|---|---|
| SamlEnvironmentException | Thrown if the artifact cannot be added to the cache. |
RemoveAsync(String)
Removes the artifact from the cache.
Declaration
Task<string> RemoveAsync(string artifact)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | artifact | The artifact. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.String> | A task that represents the remove operation and returns the associated artifact state. |
Exceptions
| Type | Condition |
|---|---|
| SamlEnvironmentException | Thrown if the artifact cannot be removed from the cache. |