SecurityTokenHandlerCollection Class

.NET Framework 4.5

Represents a collection of security token handlers.

System.Object
  System.Collections.ObjectModel.Collection<SecurityTokenHandler>
    System.IdentityModel.Tokens.SecurityTokenHandlerCollection

Namespace:  System.IdentityModel.Tokens
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public class SecurityTokenHandlerCollection : Collection<SecurityTokenHandler>

The SecurityTokenHandlerCollection type exposes the following members.

  NameDescription
Public methodSecurityTokenHandlerCollection()Initializes a new instance of the SecurityTokenHandlerCollection class.
Public methodSecurityTokenHandlerCollection(IEnumerable<SecurityTokenHandler>)Initializes a new instance of the SecurityTokenHandlerCollection class with the specified token handlers.
Public methodSecurityTokenHandlerCollection(SecurityTokenHandlerConfiguration)Initializes a new instance of the SecurityTokenHandlerCollection class with the specified configuration.
Public methodSecurityTokenHandlerCollection(IEnumerable<SecurityTokenHandler>, SecurityTokenHandlerConfiguration)Initializes a new instance of the SecurityTokenHandlerCollection class with the specified token handlers and configuration.
Top

  NameDescription
Public propertyConfigurationGets and sets the base configuration for this security token handler collection.
Public propertyCountGets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>.)
Public propertyItem[Int32]Gets or sets the element at the specified index. (Inherited from Collection<T>.)
Public propertyItem[SecurityToken]Gets a token handler from this collection that can handle the specified security token.
Public propertyItem[String]Gets a token handler from this collection that can handle the specified type identifier.
Public propertyItem[Type]Gets the handler from this collection that can handle the specified token type.
Protected propertyItemsGets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>.)
Public propertyTokenTypeIdentifiersGets a list of the type identifiers of the tokens handled by the handlers in this collection.
Public propertyTokenTypesGets a list of the types of the tokens handled by handlers in this collection.
Top

  NameDescription
Public methodAddAdds an object to the end of the Collection<T>. (Inherited from Collection<T>.)
Public methodAddOrReplaceAdds the specified token handler to this collection. If a handler with the same token type identifier as the specified handler already exists in the collection, it is replaced with the specified handler.
Public methodCanReadKeyIdentifierClauseReturns a value that indicates whether the specified key identifier clause can be read by one of the handlers in this collection or by the base WSSecurityTokenSerializer.
Protected methodCanReadKeyIdentifierClauseCoreReturns a value that indicates whether the specified key identifier clause can be read by one of the handlers in the collection or by the base WSSecurityTokenSerializer.
Public methodCanReadToken(String)Returns a value that indicates whether the specified string representation of a token can be read by one of the handlers in this collection.
Public methodCanReadToken(XmlReader)Returns a value that indicates whether the specified token can be read by one of the handlers in this collection.
Public methodCanWriteTokenReturns a value that indicates whether the specified token can be serialized by one of the handlers in this collection.
Public methodClearRemoves all elements from the Collection<T>. (Inherited from Collection<T>.)
Protected methodClearItemsClears all of the handlers from this collection. (Override of the base class method.) (Overrides Collection<T>.ClearItems().)
Public methodContainsDetermines whether an element is in the Collection<T>. (Inherited from Collection<T>.)
Public methodCopyToCopies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>.)
Public methodStatic memberCreateDefaultSecurityTokenHandlerCollection()Creates a system default collection of basic security token handlers, each of which has the system default configuration. The token handlers in this collection must be configured with service specific data before they can be used.
Public methodStatic memberCreateDefaultSecurityTokenHandlerCollection(SecurityTokenHandlerConfiguration)Creates a system default collection of basic security token handlers and associates the specified configuration with the new collection. Each of the handlers has the system default configuration. The token handlers in this collection must be configured with service specific data before they can be used.
Public methodCreateTokenCreates a token from the specified token descriptor.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfSearches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>.)
Public methodInsertInserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>.)
Protected methodInsertItemInserts the specified token handler in this collection at the specified index. (Override of the base class method.) (Overrides Collection<T>.InsertItem(Int32, T).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadKeyIdentifierClauseDeserializes a key identifier clause from the specified XML reader.
Protected methodReadKeyIdentifierClauseCoreDeserializes a key identifier clause from the specified XML reader.
Public methodReadToken(String)Deserializes a security token from the specified string.
Public methodReadToken(XmlReader)Deserializes a security token from the specified XML reader.
Public methodRemoveRemoves the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>.)
Public methodRemoveAtRemoves the element at the specified index of the Collection<T>. (Inherited from Collection<T>.)
Protected methodRemoveItemRemoves the handler at the specified index from this collection. (Override of the base class method.) (Overrides Collection<T>.RemoveItem(Int32).)
Protected methodSetItemReplaces the token handler at the specified index in the collection with the specified handler. (Overrides Collection<T>.SetItem(Int32, T).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodValidateTokenValidates the specified security token.
Public methodWriteKeyIdentifierClauseSerializes the specified key identifier clause to XML.
Protected methodWriteKeyIdentifierClauseCoreSerializes the specified key identifier clause to XML.
Public methodWriteToken(SecurityToken)Serializes the specified security token to a string.
Public methodWriteToken(XmlWriter, SecurityToken)Serializes the specified security token to XML.
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection<T>.IsReadOnlyGets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorReturns an enumerator that iterates through a collection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.AddAdds an item to the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.ContainsDetermines whether the IList contains a specific value. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.IndexOfDetermines the index of a specific item in the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.InsertInserts an item into the IList at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList.IsFixedSizeGets a value indicating whether the IList has a fixed size. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList.IsReadOnlyGets a value indicating whether the IList is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertyIList.ItemGets or sets the element at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodIList.RemoveRemoves the first occurrence of a specific object from the IList. (Inherited from Collection<T>.)
Top

.NET Framework

Supported in: 4.6, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft