SecurityTokenManager.LoadSecurityTokenAssertion Method

Article
09/15/2006

Loads a security token policy assertion from the specified XML element.

Namespace: Microsoft.Web.Services2.Security.Tokens
Assembly: Microsoft.Web.Services2 (in microsoft.web.services2.dll)

Usage

'Usage
Dim element As XmlElement
Dim returnValue As ISecurityTokenAssertion
Dim securityTokenManager1 As SecurityTokenManager
returnValue = securityTokenManager1.LoadSecurityTokenAssertion(element)

Syntax

'Declaration
Public Overridable Function LoadSecurityTokenAssertion( _
    ByVal element As XmlElement _
) As ISecurityTokenAssertion

public virtual ISecurityTokenAssertion LoadSecurityTokenAssertion(
    XmlElement element
);

public: ISecurityTokenAssertion^ LoadSecurityTokenAssertion(
    XmlElement^ element
);

public ISecurityTokenAssertion LoadSecurityTokenAssertion(
    XmlElement element
);

public function LoadSecurityTokenAssertion(
     element : XmlElement
) : ISecurityTokenAssertion;

Parameters

element
An System.Xml.XmlElement from a policy assertion that references the specific security token type.

Return Value

An ISecurityTokenAssertion that contains the policy for received or sent security tokens of a specific type. Null if element is not understood.

Remarks

Use the LoadSecurityTokenAssertion method to parse the XML elements of policy assertions that reference the specific security token type. The ISecurityTokenAssertion returned from this method can then be passed to the LoadTokenFromSecurityTokenAssertion method to create an instance of the specific security token type that satisfies the conditions of the security token policy assertion.

This method is typically only called when WSE calls the GetSecurityTokenAssertion method.

Notes to Inheritors: Override this method when the security token is used with policy. This method should return null if this function is not supported in a particular security token manager implementation. The default implementation of this method simply returns null.

Thread Safety

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

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server, Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, Pocket PC, Windows CE, Smart Phone