SecurityTokenHandler.CanWriteToken SecurityTokenHandler.CanWriteToken SecurityTokenHandler.CanWriteToken SecurityTokenHandler.CanWriteToken Property

Definition

Gets a value that indicates whether the handler can serialize security tokens.

public:
 virtual property bool CanWriteToken { bool get(); };
public virtual bool CanWriteToken { get; }
member this.CanWriteToken : bool
Public Overridable ReadOnly Property CanWriteToken As Boolean

Property Value

true if the class is capable of serializing tokens; otherwise false. The default is false.

Examples

The following code shows how to override the CanWriteToken property to indicate that a custom handler can serialize tokens. The code is taken from the Custom Token sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see WIF Code Sample Index.

/// <summary>
/// Gets a value indicating whether the SecurityTokenHandler can Serialize Tokens. Return true by default.
/// </summary>
/// <value>True is the handler can serialize tokens of type <see cref="SimpleWebToken"/>.</value>
public override bool CanWriteToken
{
    get
    {
        return true;
    }
}

Remarks

To implement serialization in a derived class, override this property to return true and override the WriteToken methods to implement the serialization logic.

Applies to