SessionSecurityTokenReceivedEventArgs Class

.NET Framework (current version)
 
Namespace:   System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      System.IdentityModel.Services.SessionSecurityTokenReceivedEventArgs

public class SessionSecurityTokenReceivedEventArgs : CancelEventArgs

NameDescription
System_CAPS_pubmethodSessionSecurityTokenReceivedEventArgs(SessionSecurityToken)

Initializes a new instance of the SecurityTokenReceivedEventArgs class that has the specified session token.

NameDescription
System_CAPS_pubpropertyCancel

Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.)

System_CAPS_pubpropertyReissueCookie

Gets or sets a value that specifies whether to reissue the session cookie with the response.

System_CAPS_pubpropertySessionToken

Gets or sets the session security token that was received.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

By default, the SessionSecurityTokenReceived event is raised from within the SessionAuthenticationModule.OnAuthenticateRequest method after a session token (SessionSecurityToken) has been successfully read from the session cookie. In the event handler, you can modify properties of the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user).

You can access the token through the SessionToken property. After modifying the token, you can ensure that it is written back to the cookie by setting the ReissueCookie to true. Finally, the SessionSecurityTokenReceived event is a cancelable event, and you can set the Cancel property (inherited from CancelEventArgs) to abort further processing of the request.

.NET Framework
Available since 4.5

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: