mcs/class/System.Web.Services/Documentation/en/System.Web.Services/WebService.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="WebService" FullName="System.Web.Services.WebService">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public class WebService : System.ComponentModel.MarshalByValueComponent" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Web.Services</AssemblyName>
   6     <AssemblyPublicKey>
   7     </AssemblyPublicKey>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.ComponentModel.MarshalByValueComponent</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16   </Interfaces>
  17   <Docs>
  18     <remarks>
  19       <attribution license="cc4" from="Microsoft" modified="false" />
  20       <para>If you don't need access to the common ASP.NET objects, you can still create an XML Web service without deriving from <see cref="T:System.Web.Services.WebService" />. Additional ASP.NET objects can be accessed through <see cref="P:System.Web.Services.WebService.Context" />.</para>
  21       <para>XML Web service methods that have the <see cref="P:System.Web.Services.Protocols.SoapRpcMethodAttribute.OneWay" /> property of either <see cref="T:System.Web.Services.Protocols.SoapRpcMethodAttribute" /> or <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> set to true, do not have access to their <see cref="T:System.Web.HttpContext" />. As such, accessing any of the properties of the <see cref="T:System.Web.Services.WebService" /> class, from within that XML Web service method, return null.</para>
  22       <para>If you are using the .NET Framework version 1.0 XML Web service methods that have either the <see cref="T:System.Web.Services.Protocols.SoapRpcMethodAttribute" /> or <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> attribute applied to them with the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay" /> property of set to true, do not have access to their <see cref="T:System.Web.HttpContext" /> using the static <see cref="P:System.Web.HttpContext.Current" /> property. To access the <see cref="T:System.Web.HttpContext" />, derive the class implementing the XML Web service method from <see cref="T:System.Web.Services.WebService" /> and access the <see cref="P:System.Web.Services.WebService.Context" /> property.</para>
  23     </remarks>
  24     <summary>
  25       <attribution license="cc4" from="Microsoft" modified="false" />
  26       <para>Defines the optional base class for XML Web services, which provides direct access to common ASP.NET objects, such as application and session state.</para>
  27     </summary>
  28   </Docs>
  29   <Members>
  30     <Member MemberName=".ctor">
  31       <MemberSignature Language="C#" Value="public WebService ();" />
  32       <MemberType>Constructor</MemberType>
  33       <ReturnValue />
  34       <Parameters />
  35       <Docs>
  36         <remarks>To be added</remarks>
  37         <summary>
  38           <attribution license="cc4" from="Microsoft" modified="false" />
  39           <para>Initializes a new instance of the <see cref="T:System.Web.Services.WebService" /> class.</para>
  40         </summary>
  41       </Docs>
  42       <AssemblyInfo>
  43         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  44         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  45       </AssemblyInfo>
  46     </Member>
  47     <Member MemberName="Application">
  48       <MemberSignature Language="C#" Value="public System.Web.HttpApplicationState Application { get; }" />
  49       <MemberType>Property</MemberType>
  50       <ReturnValue>
  51         <ReturnType>System.Web.HttpApplicationState</ReturnType>
  52       </ReturnValue>
  53       <Parameters />
  54       <Docs>
  55         <value>a <see cref="T:System.Web.HttpApplicationState" /></value>
  56         <remarks>
  57           <attribution license="cc4" from="Microsoft" modified="false" />
  58           <para>XML Web services can use both application state and session state. Application state is maintained across all sessions accessing an XML Web service regardless of whether session state is turned off for a method(by using the <see cref="P:System.Web.Services.WebMethodAttribute.EnableSession" /> property of the <see cref="T:System.Web.Services.WebMethodAttribute" />).</para>
  59         </remarks>
  60         <summary>
  61           <attribution license="cc4" from="Microsoft" modified="false" />
  62           <para>Gets the application object for the current HTTP request.</para>
  63         </summary>
  64       </Docs>
  65       <AssemblyInfo>
  66         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  67         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  68       </AssemblyInfo>
  69       <Attributes>
  70         <Attribute>
  71           <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  72         </Attribute>
  73         <Attribute>
  74           <AttributeName>System.ComponentModel.Description("The ASP.NET application object for the current request.")</AttributeName>
  75         </Attribute>
  76         <Attribute>
  77           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  78         </Attribute>
  79       </Attributes>
  80     </Member>
  81     <Member MemberName="Context">
  82       <MemberSignature Language="C#" Value="public System.Web.HttpContext Context { get; }" />
  83       <MemberType>Property</MemberType>
  84       <ReturnValue>
  85         <ReturnType>System.Web.HttpContext</ReturnType>
  86       </ReturnValue>
  87       <Parameters />
  88       <Docs>
  89         <value>a <see cref="T:System.Web.HttpContext" /></value>
  90         <remarks>
  91           <attribution license="cc4" from="Microsoft" modified="false" />
  92           <para>XML Web service methods that have either the <see cref="T:System.Web.Services.Protocols.SoapRpcMethodAttribute" /> or <see cref="T:System.Web.Services.Protocols.SoapDocumentMethodAttribute" /> attribute applied to them with the <see cref="P:System.Web.Services.Protocols.SoapDocumentMethodAttribute.OneWay" /> property of set to true, do not have access to their <see cref="T:System.Web.HttpContext" /> using the static <see cref="P:System.Web.HttpContext.Current" /> property. To access the <see cref="T:System.Web.HttpContext" />, derive the class implementing the XML Web service method from <see cref="T:System.Web.Services.WebService" /> and access the <see cref="P:System.Web.Services.WebService.Context" /> property.</para>
  93         </remarks>
  94         <summary>
  95           <attribution license="cc4" from="Microsoft" modified="false" />
  96           <para>Gets the ASP.NET <see cref="T:System.Web.HttpContext" /> for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests.</para>
  97         </summary>
  98       </Docs>
  99       <AssemblyInfo>
 100         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 101         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 102       </AssemblyInfo>
 103       <Attributes>
 104         <Attribute>
 105           <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
 106         </Attribute>
 107         <Attribute>
 108           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 109         </Attribute>
 110       </Attributes>
 111     </Member>
 112     <Member MemberName="Server">
 113       <MemberSignature Language="C#" Value="public System.Web.HttpServerUtility Server { get; }" />
 114       <MemberType>Property</MemberType>
 115       <ReturnValue>
 116         <ReturnType>System.Web.HttpServerUtility</ReturnType>
 117       </ReturnValue>
 118       <Parameters />
 119       <Docs>
 120         <value>a <see cref="T:System.Web.HttpServerUtility" /></value>
 121         <remarks>
 122           <attribution license="cc4" from="Microsoft" modified="false" />
 123           <para>The <see cref="T:System.Web.HttpServerUtility" /> class provides several methods that can be used in the processing of Web requests, including <see cref="M:System.Web.HttpServerUtility.CreateObject(System.String)" /> (for instantiating COM objects).</para>
 124         </remarks>
 125         <summary>
 126           <attribution license="cc4" from="Microsoft" modified="false" />
 127           <para>Gets the <see cref="T:System.Web.HttpServerUtility" /> for the current request.</para>
 128         </summary>
 129       </Docs>
 130       <AssemblyInfo>
 131         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 132         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 133       </AssemblyInfo>
 134       <Attributes>
 135         <Attribute>
 136           <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
 137         </Attribute>
 138         <Attribute>
 139           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 140         </Attribute>
 141       </Attributes>
 142     </Member>
 143     <Member MemberName="Session">
 144       <MemberSignature Language="C#" Value="public System.Web.SessionState.HttpSessionState Session { get; }" />
 145       <MemberType>Property</MemberType>
 146       <ReturnValue>
 147         <ReturnType>System.Web.SessionState.HttpSessionState</ReturnType>
 148       </ReturnValue>
 149       <Parameters />
 150       <Docs>
 151         <value>a <see cref="T:System.Web.SessionState.HttpSessionState" /></value>
 152         <remarks>To be added</remarks>
 153         <summary>
 154           <attribution license="cc4" from="Microsoft" modified="false" />
 155           <para>Gets the <see cref="T:System.Web.SessionState.HttpSessionState" /> instance for the current request.</para>
 156         </summary>
 157       </Docs>
 158       <AssemblyInfo>
 159         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 160         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162       <Attributes>
 163         <Attribute>
 164           <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
 165         </Attribute>
 166         <Attribute>
 167           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 168         </Attribute>
 169       </Attributes>
 170     </Member>
 171     <Member MemberName="SoapVersion">
 172       <MemberSignature Language="C#" Value="public System.Web.Services.Protocols.SoapProtocolVersion SoapVersion { get; }" />
 173       <MemberType>Property</MemberType>
 174       <AssemblyInfo>
 175         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 176       </AssemblyInfo>
 177       <Attributes>
 178         <Attribute>
 179           <AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
 180         </Attribute>
 181         <Attribute>
 182           <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
 183         </Attribute>
 184         <Attribute>
 185           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 186         </Attribute>
 187       </Attributes>
 188       <ReturnValue>
 189         <ReturnType>System.Web.Services.Protocols.SoapProtocolVersion</ReturnType>
 190       </ReturnValue>
 191       <Docs>
 192         <value>To be added.</value>
 193         <remarks>
 194           <attribution license="cc4" from="Microsoft" modified="false" />
 195           <para>If the SOAP protocol was not used to communicate with the XML Web service, such as HTTP-GET or HTTP-POST, the value of the <see cref="P:System.Web.Services.WebService.SoapVersion" /> property is <see cref="F:System.Web.Services.Protocols.SoapProtocolVersion.Default" />.</para>
 196           <para>For XML Web services that do not derive from the <see cref="T:System.Web.Services.WebService" /> class, the version of the SOAP protocol used to make the SOAP request to the XML Web service can be also be accessed using the "WebServiceSoapVersion" entry of the <see cref="P:System.Web.HttpContext.Items" /> property. That entry is of type <see cref="T:System.Web.Services.Protocols.SoapProtocolVersion" />.</para>
 197         </remarks>
 198         <summary>
 199           <attribution license="cc4" from="Microsoft" modified="false" />
 200           <para>Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service.</para>
 201         </summary>
 202       </Docs>
 203     </Member>
 204     <Member MemberName="User">
 205       <MemberSignature Language="C#" Value="public System.Security.Principal.IPrincipal User { get; }" />
 206       <MemberType>Property</MemberType>
 207       <ReturnValue>
 208         <ReturnType>System.Security.Principal.IPrincipal</ReturnType>
 209       </ReturnValue>
 210       <Parameters />
 211       <Docs>
 212         <value>a <see cref="T:System.Security.Principal.IPrincipal" /></value>
 213         <remarks>
 214           <attribution license="cc4" from="Microsoft" modified="false" />
 215           <para>Both Internet Information Services (IIS) and the .NET Framework need to be configured for authentication in order for the <see cref="P:System.Web.Services.WebService.User" /> property to be meaningful. Authentication is the process of accepting credentials from a user and validating those credentials against some authority. If the credentials are valid, you have an authenticated identity. Authentication in the .NET Framework is configured by placing entries in the web.config file.</para>
 216           <para>The following example demonstrates the entries you place in the web.config file to enable Windows authentication.</para>
 217           <code> &lt;security&gt;
 218   &lt;authentication mode="Windows"&gt; &lt;!-- Mode Options are Windows, Cookie, Passport and None or Empty String --&gt;
 219   &lt;/authentication&gt;
 220   &lt;/security&gt;</code>
 221           <para>For more information on setting up security for an XML Web service see <format type="text/html"><a href="354B2AB1-2782-4542-B32A-DC560178B90C">[&lt;topic://cpconSecuringASPNETWebServices&gt;]</a></format>.</para>
 222         </remarks>
 223         <summary>
 224           <attribution license="cc4" from="Microsoft" modified="false" />
 225           <para>Gets the ASP.NET server <see cref="P:System.Web.HttpContext.User" /> object. Can be used to authenticate whether a user is authorized to execute the request.</para>
 226         </summary>
 227       </Docs>
 228       <AssemblyInfo>
 229         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 230         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 231       </AssemblyInfo>
 232       <Attributes>
 233         <Attribute>
 234           <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
 235         </Attribute>
 236         <Attribute>
 237           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 238         </Attribute>
 239       </Attributes>
 240     </Member>
 241   </Members>
 242 </Type>