WSTrustServiceHost Class

Reference

Definition

Namespace:: System.ServiceModel.Security

Assembly:: System.ServiceModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a ServiceHost for registering a SecurityTokenService The service host will have multiple endpoints registered based on the number of listeners registered in the configuration.

public ref class WSTrustServiceHost : System::ServiceModel::ServiceHost

public class WSTrustServiceHost : System.ServiceModel.ServiceHost

type WSTrustServiceHost = class
    inherit ServiceHost

Public Class WSTrustServiceHost
Inherits ServiceHost

Inheritance: Object

CommunicationObject

ServiceHostBase

ServiceHost
WSTrustServiceHost

Remarks

By default, the WSTrustServiceHost class provides the following:

It adds WS-Trust endpoints to the ServiceHost.
It enables metadata over the base addresses if the DisableWsdl property is set to false.
It configures the service certificate on the ServiceHost service credentials if a WIF configuration section specifies a service certificate. Note that this will override the equivalent service certificate settings in WCF configuration.
It integrates IdentityModel token handlers into the security processing pipeline by calling the ExtensibleSecurityCredentials.ConfigureServiceHost method on itself.

The WSTrustServiceHost class may be overridden to customize this behavior.

Constructors

WSTrustServiceHost(SecurityTokenServiceConfiguration, Uri[])	Initializes a new instance of the WSTrustServiceHost class with the specified base addresses and service (STS) configuration settings.
WSTrustServiceHost(WSTrustServiceContract, Uri[])	Initializes a new instance of the WSTrustServiceHost class with the specified base addresses and service contract.

Properties

Authentication	Gets the service authentication behavior. (Inherited from ServiceHostBase)
Authorization	Gets the authorization behavior for the service hosted. (Inherited from ServiceHostBase)
BaseAddresses	Gets the base addresses used by the hosted service. (Inherited from ServiceHostBase)
ChannelDispatchers	Gets the collection of channel dispatchers used by the service host. (Inherited from ServiceHostBase)
CloseTimeout	Gets or sets the interval of time allowed for the service host to close. (Inherited from ServiceHostBase)
Credentials	Gets the credential for the service hosted. (Inherited from ServiceHostBase)
DefaultCloseTimeout	Gets the default interval of time allowed for the service host to close. (Inherited from ServiceHostBase)
DefaultOpenTimeout	Gets the default interval of time allowed for the service host to open. (Inherited from ServiceHostBase)
Description	Gets the description of the service hosted. (Inherited from ServiceHostBase)
Extensions	Gets the extensions for the current specified service host. (Inherited from ServiceHostBase)
ImplementedContracts	Retrieves the contracts implemented by the service hosted. (Inherited from ServiceHostBase)
IsDisposed	Gets a value that indicates whether the communication object has been disposed. (Inherited from CommunicationObject)
ManualFlowControlLimit	Gets or sets the flow control limit for messages received by the service hosted. (Inherited from ServiceHostBase)
OpenTimeout	Gets or sets the interval of time allowed for the service host to open. (Inherited from ServiceHostBase)
SecurityTokenServiceConfiguration	Gets the security token service (STS) configuration for this instance.
ServiceContract	Gets the service contract associated with this instance.
SingletonInstance	Gets the singleton instance of the hosted service. (Inherited from ServiceHost)
State	Gets a value that indicates the current state of the communication object. (Inherited from CommunicationObject)
ThisLock	Gets the mutually exclusive lock that protects the class instance during a state transition. (Inherited from CommunicationObject)

Methods

Abort()	Causes a communication object to transition immediately from its current state into the closing state. (Inherited from CommunicationObject)
AddBaseAddress(Uri)	Adds a base address to the service host. (Inherited from ServiceHostBase)
AddDefaultEndpoints()	Adds service endpoints for all base addresses in each contract found in the service host with the default binding. (Inherited from ServiceHostBase)
AddServiceEndpoint(ServiceEndpoint)	Adds the specified service endpoint to the hosted service. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, String, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, endpoint address and URI that contains the address at which it listens. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, String)	Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, Uri, Uri)	Adds a service endpoint to the hosted service with the specified contract, binding, and URIs that contain the endpoint and listening addresses. (Inherited from ServiceHostBase)
AddServiceEndpoint(String, Binding, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, and a URI that contains the endpoint address. (Inherited from ServiceHostBase)
AddServiceEndpoint(Type, Binding, String, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, an endpoint address, and a URI on which the service listens. (Inherited from ServiceHost)
AddServiceEndpoint(Type, Binding, String)	Adds a service endpoint to the hosted service with a specified contract, binding, and endpoint address. (Inherited from ServiceHost)
AddServiceEndpoint(Type, Binding, Uri, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, a URI that contains the endpoint address, and a URI on which the service listens. (Inherited from ServiceHost)
AddServiceEndpoint(Type, Binding, Uri)	Adds a service endpoint to the hosted service with a specified contract, binding, and URI that contains the endpoint address. (Inherited from ServiceHost)
ApplyConfiguration()	Loads the service description information from the configuration file and applies it to the runtime that is being constructed.
BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close a communication object with a specified timeout. (Inherited from CommunicationObject)
BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time. (Inherited from CommunicationObject)
Close()	Causes a communication object to transition from its current state into the closed state. (Inherited from CommunicationObject)
Close(TimeSpan)	Causes a communication object to transition from its current state into the closed state within a specified interval of time. (Inherited from CommunicationObject)
ConfigureMetadata()	Configures metadata (WSDL) for the service host.
CreateDescription(IDictionary<String,ContractDescription>)	Creates a description of the service hosted. (Inherited from ServiceHost)
EndClose(IAsyncResult)	Completes an asynchronous operation to close a communication object. (Inherited from CommunicationObject)
EndOpen(IAsyncResult)	Completes an asynchronous operation to open a communication object. (Inherited from CommunicationObject)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Fault()	Causes a communication object to transition from its current state into the faulted state. (Inherited from CommunicationObject)
GetCommunicationObjectType()	Gets the type of communication object. (Inherited from CommunicationObject)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IncrementManualFlowControlLimit(Int32)	Increases the limit on the flow rate of messages to the hosted service by a specified increment. (Inherited from ServiceHostBase)
InitializeDescription(Object, UriSchemeKeyedCollection)	Initializes a description of the service hosted based on its instance and specified base addresses. (Inherited from ServiceHost)
InitializeDescription(Type, UriSchemeKeyedCollection)	Initializes a description of the service hosted based on its type and specified base addresses. (Inherited from ServiceHost)
InitializeDescription(UriSchemeKeyedCollection)	Creates and initializes the service host with the contract and service descriptions. (Inherited from ServiceHostBase)
InitializeRuntime()	Override of the base class method. Configures the ServiceConfiguration on the service host and then invokes the base implementation.
LoadConfigurationSection(ServiceElement)	Loads the service element from the configuration file of the hosted service. (Inherited from ServiceHostBase)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAbort()	Aborts the service. (Inherited from ServiceHostBase)
OnBeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation invoked on the close of the service host. (Inherited from ServiceHostBase)
OnBeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation invoked on the opening of the service host. (Inherited from ServiceHostBase)
OnClose(TimeSpan)	Closes down the hosted service, including their channel dispatchers and associated instance contexts and listeners. (Inherited from ServiceHostBase)
OnClosed()	Disposes of disposable services that are being hosted when the service host is closed. (Inherited from ServiceHost)
OnClosing()	Invoked during the transition of a communication object into the closing state. (Inherited from CommunicationObject)
OnEndClose(IAsyncResult)	Completes an asynchronous operation invoked on the closing of the service host. (Inherited from ServiceHostBase)
OnEndOpen(IAsyncResult)	Completes an asynchronous operation invoked on the opening of the service host. (Inherited from ServiceHostBase)
OnFaulted()	Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation. (Inherited from CommunicationObject)
OnOpen(TimeSpan)	Opens the channel dispatchers. (Inherited from ServiceHostBase)
OnOpened()	Gets the service credentials,service authentication and authorization behavior for the hosted service. (Inherited from ServiceHostBase)
OnOpening()	Invoked during the transition of a communication object into the opening state. (Inherited from CommunicationObject)
Open()	Causes a communication object to transition from the created state into the opened state. (Inherited from CommunicationObject)
Open(TimeSpan)	Causes a communication object to transition from the created state into the opened state within a specified interval of time. (Inherited from CommunicationObject)
ReleasePerformanceCounters()	Releases the service and channel dispatcher performance counters for the hosted service. (Inherited from ServiceHostBase)
SetEndpointAddress(ServiceEndpoint, String)	Sets the endpoint address of the specified endpoint to the specified address. (Inherited from ServiceHostBase)
ThrowIfDisposed()	Throws an exception if the communication object is disposed. (Inherited from CommunicationObject)
ThrowIfDisposedOrImmutable()	Throws an exception if the communication object the State property is not set to the Created state. (Inherited from CommunicationObject)
ThrowIfDisposedOrNotOpen()	Throws an exception if the communication object is not in the Opened state. (Inherited from CommunicationObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)
UpdateServiceConfiguration()	Overrides the IdentityConfiguration on the Credentials property of the service host with the SecurityTokenServiceConfiguration property.

Events

Closed	Occurs when a communication object transitions into the closed state. (Inherited from CommunicationObject)
Closing	Occurs when a communication object transitions into the closing state. (Inherited from CommunicationObject)
Faulted	Occurs when a communication object transitions into the faulted state. (Inherited from CommunicationObject)
Opened	Occurs when a communication object transitions into the opened state. (Inherited from CommunicationObject)
Opening	Occurs when a communication object transitions into the opening state. (Inherited from CommunicationObject)
UnknownMessageReceived	Occurs when an unknown message is received. (Inherited from ServiceHostBase)

Explicit Interface Implementations

IDisposable.Dispose()

Closes the service host.

(Inherited from ServiceHostBase)

Applies to

Share via