Class DatabaseSSOSessionStore

The single sign-on session store stores single sign-on session state in a database.

Inheritance

System.Object

AbstractSSOSessionStore

DatabaseSSOSessionStore

Implements

ISSOSessionStore

Inherited Members

AbstractSSOSessionStore.Serialize(Object)

AbstractSSOSessionStore.Deserialize(Byte[])

AbstractSSOSessionStore.CreateSessionIDForType(Type)

AbstractSSOSessionStore.SessionID

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Data

Assembly: ComponentSpace.Saml2.dll

Syntax

public class DatabaseSSOSessionStore : AbstractSSOSessionStore, ISSOSessionStore

Constructors

DatabaseSSOSessionStore()

Constructs a DatabaseSSOSessionStore.

The default database connection string name is assumed to be configured in web.config.

Declaration

public DatabaseSSOSessionStore()

DatabaseSSOSessionStore(String)

Constructs a DatabaseSSOSessionStore.

Declaration

public DatabaseSSOSessionStore(string connectionStringName)

Parameters

Type	Name	Description
System.String	connectionStringName	The database connection string name configured in web.config.

DatabaseSSOSessionStore(String, String)

Constructs a DatabaseSSOSessionStore.

Declaration

public DatabaseSSOSessionStore(string connectionStringName, string tableName)

Parameters

Type	Name	Description
System.String	connectionStringName	The database connection string name configured in web.config.
System.String	tableName	The database table name or null to use the default name.

DatabaseSSOSessionStore(String, String, String)

Constructs a DatabaseSSOSessionStore.

Declaration

public DatabaseSSOSessionStore(string providerName, string connectionString, string tableName)

Parameters

Type	Name	Description
System.String	providerName	The database provider name.
System.String	connectionString	The database connection string.
System.String	tableName	The database table name or null to use the default name.

Properties

DeleteExpiredPriorToAdd

Gets or sets the flag indicating whether expired entries should be deleted prior to saving an entry. The default is true.

Declaration

public bool DeleteExpiredPriorToAdd { get; set; }

Property Value

Type	Description
System.Boolean	The flag indicating whether expired entries should be deleted prior to saving an entry.

ExpirationDateTimeColumnName

Gets or sets the name of the expiration date/time column. The default name is ExpirationDateTime.

Declaration

public string ExpirationDateTimeColumnName { get; set; }

Property Value

Type	Description
System.String	The name of the expiration date/time column.

ExpirationTimeSpan

Gets or sets the session state expiration timespan. The default expiration period is one hour.

Declaration

public TimeSpan ExpirationTimeSpan { get; set; }

Property Value

Type	Description
System.TimeSpan	The session state expiration timespan.

SessionIDColumnName

Gets or sets the name of the session ID column. The default name is SessionID.

Declaration

public string SessionIDColumnName { get; set; }

Property Value

Type	Description
System.String	The name of the session ID column.

SessionObjectColumnName

Gets or sets the name of the session object column. The default name is SessionObject.

Declaration

public string SessionObjectColumnName { get; set; }

Property Value

Type	Description
System.String	The name of the session object column.

Methods

Delete(Type)

Deletes the SSO session object.

Declaration

public override void Delete(Type type)

Parameters

Type	Name	Description
System.Type	type	The SSO session object type.

Overrides

AbstractSSOSessionStore.Delete(Type)

DeleteExpired()

Deletes any expired SSO session objects from the database.

Declaration

public virtual int DeleteExpired()

Returns

Type	Description
System.Int32	The number of expired SSO session objects deleted from the database.

Dispose()

Dispose of the database ID cache.

Declaration

public void Dispose()

Dispose(Boolean)

Dispose of the database SSO session store.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true if called by user code; false if called by the runtime from within the finalizer

Load(Type)

Loads the SSO session object.

Declaration

public override object Load(Type type)

Parameters

Type	Name	Description
System.Type	type	The SSO session object type.

Returns

Type	Description
System.Object	The SSO session object or null if none.

Overrides

AbstractSSOSessionStore.Load(Type)

Save(Object)

Saves the SSO session object.

Declaration

public override void Save(object ssoSession)

Parameters

Type	Name	Description
System.Object	ssoSession	The serializable SSO session object.

Overrides

AbstractSSOSessionStore.Save(Object)

StartDeletingExpired(TimeSpan, TimeSpan)

Schedules the deletion of expired SSO session objects starting at the due time and repeating periodically.

Declaration

public virtual void StartDeletingExpired(TimeSpan dueTime, TimeSpan period)

Parameters

Type	Name	Description
System.TimeSpan	dueTime	The due time to start deleting expired SSO session objects.
System.TimeSpan	period	The period to wait before next deleting expired SSO session objects.

StopDeletingExpired()

Stops any scheduled deletion of expired SSO session objects.

Declaration

public virtual void StopDeletingExpired()

Implements

ISSOSessionStore