Language

SecurityTokenHandler.CanWriteToken プロパティ

定義

ハンドラーがセキュリティ トークンをシリアル化できるかどうかを示す値を取得します。

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

プロパティ値

true クラスがトークンをシリアル化できる場合。それ以外の場合は false。 既定値は false です。

例

次のコードは、カスタム ハンドラーがトークンをシリアル化できることを示すために、 CanWriteToken プロパティをオーバーライドする方法を示しています。 このコードは、 Custom Token サンプルから取得します。 このサンプルでは、Simple Web Tokens (SWT) の処理を有効にするカスタム クラスを提供します。 WIF で使用できるこのサンプルとその他のサンプルの詳細については、 WIF コード サンプル インデックスを参照してください。

/// <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;
    }
}

注釈

派生クラスでシリアル化を実装するには、このプロパティをオーバーライドして true を返し、 WriteToken メソッドをオーバーライドしてシリアル化ロジックを実装します。

適用対象