DiscoveryReference Class (System.Web.Services.Discovery)

Switch View :
ScriptFree
.NET Framework Class Library
DiscoveryReference Class

The base class for discoverable references using XML Web services discovery.

Namespace:  System.Web.Services.Discovery
Assembly:  System.Web.Services (in System.Web.Services.dll)
Syntax

Visual Basic (Declaration)
Public MustInherit Class DiscoveryReference
Visual Basic (Usage)
Dim instance As DiscoveryReference
C#
public abstract class DiscoveryReference
Visual C++
public ref class DiscoveryReference abstract
JScript
public abstract class DiscoveryReference
Remarks

ContractReference , SchemaReference, and DiscoveryDocumentReference all inherit from DiscoveryReference, and represent the three types of documents discoverable through XML Web services discovery: Service Descriptions, XML Schema Definition (XSD) schemas, and discovery documents, respectively.

Examples

Visual Basic
Imports System
Imports System.IO
Imports System.Web.Services.Discovery
Imports System.Net

Class MyDiscoveryDocumentClass
   Public Shared Sub Main()
      Try
         Dim myDiscoveryDocument As DiscoveryDocument
         Dim myStreamReader As New StreamReader("c:\Inetpub\wwwroot\dataservice.disco")
         Dim myStream As New FileStream("c:\MyDiscovery.disco", FileMode.OpenOrCreate)
         Console.WriteLine("Demonstrating DiscoveryReference class.")

         ' Read the discovery file.
         myDiscoveryDocument = DiscoveryDocument.Read(myStreamReader)

         ' Create an instance of the DiscoveryReference class.
         Dim myDiscoveryReference As MyDiscoveryReferenceClass
         myDiscoveryReference = New MyDiscoveryReferenceClass()

         Dim myDiscoveryClientProtocol As New DiscoveryClientProtocol()
         myDiscoveryClientProtocol.Credentials = _
             CredentialCache.DefaultCredentials

         ' Set the client protocol.
         myDiscoveryReference.ClientProtocol = myDiscoveryClientProtocol

         ' Read the default file name.
         Console.WriteLine("Default file name is: " _
             & myDiscoveryReference.DefaultFilename)

         ' Write the document.
         myDiscoveryReference.WriteDocument(myDiscoveryDocument, myStream)

         ' Read the document.
         myDiscoveryReference.ReadDocument(myStream)

         ' Set the URL.
         myDiscoveryReference.Url = "http://localhost/dataservice.disco"
         Console.WriteLine("Url is : " + myDiscoveryReference.Url)

         ' Resolve the URL.
         myDiscoveryReference.Resolve()

         myStreamReader.Close()
         myStream.Close()

      Catch e as Exception
         Console.WriteLine("Exception caught! - {0}", e.Message)
      End Try

   End Sub

End Class


' Class derived from DiscoveryReference class and overriding it members.
Class MyDiscoveryReferenceClass
   Inherits DiscoveryReference
   Private myDocumentUrl As String

   Public Overrides ReadOnly Property DefaultFilename() As String
      Get
         Return "dataservice.disco"
      End Get
   End Property

   Public Overrides Function _
      ReadDocument(ByVal stream As System.IO.Stream) As Object
      Return stream
   End Function

   Public Overloads Sub Resolve()
      Try
         Dim myDiscoveryRefDocument As DiscoveryDocument
         myDiscoveryRefDocument = MyBase.ClientProtocol.Discover(Url)
      Catch e As Exception
         Throw e
      End Try
   End Sub

   Protected Overloads Overrides Sub _
      Resolve(ByVal contentType As String, ByVal stream As Stream)
   End Sub

   Public Overrides Property Url() As String
      Get
         Return myDocumentUrl
      End Get

      Set(ByVal Value As String)
         myDocumentUrl = Value
      End Set
   End Property

   Public Overrides Sub WriteDocument _
      (ByVal document As Object, ByVal stream As System.IO.Stream)
      Dim myDiscoveryDocument As DiscoveryDocument = _
          CType(document, DiscoveryDocument)
      myDiscoveryDocument.Write(stream)
   End Sub
End Class


C#
using System;
using System.IO;
using System.Web.Services.Discovery;
using System.Net;

class MyDiscoveryDocumentClass
{
   static void Main()
   {
      try {
         DiscoveryDocument myDiscoveryDocument;
         StreamReader myStreamReader = 
             new StreamReader("c:\\Inetpub\\wwwroot\\dataservice.disco");
         FileStream myStream = new FileStream("c:\\MyDiscovery.disco",
             FileMode.OpenOrCreate);
         Console.WriteLine("Demonstrating DiscoveryReference class.");

         // Read discovery file.
         myDiscoveryDocument = DiscoveryDocument.Read(myStreamReader);

         // Create a new instance of the DiscoveryReference class.
         MyDiscoveryReferenceClass myDiscoveryReference;
         myDiscoveryReference =  new MyDiscoveryReferenceClass();

         DiscoveryClientProtocol myDiscoveryClientProtocol = 
             new DiscoveryClientProtocol();
         myDiscoveryClientProtocol.Credentials = 
             CredentialCache.DefaultCredentials;

         // Set the client protocol.
         myDiscoveryReference.ClientProtocol = myDiscoveryClientProtocol;

         // Read the default file name.
         Console.WriteLine("Default file name is: " 
             + myDiscoveryReference.DefaultFilename);

         // Write the document.
         myDiscoveryReference.WriteDocument(myDiscoveryDocument,myStream);

         // Read the document.
         myDiscoveryReference.ReadDocument(myStream);

         // Set the URL. 
         myDiscoveryReference.Url = "http://localhost/dataservice.disco";
         Console.WriteLine("Url is: " + myDiscoveryReference.Url);

         // Resolve the URL.
         myDiscoveryReference.Resolve();

         myStreamReader.Close();
         myStream.Close();
      }
      catch (Exception e) 
      {
         Console.WriteLine("Exception caught! - {0}", e.Message);
      }
   }
}

// Class derived from DiscoveryReference class and overriding it members.
class MyDiscoveryReferenceClass : DiscoveryReference
{
   private string myDocumentUrl;
   public override string DefaultFilename
   {
      get
      {
         return "dataservice.disco";
      }
   }

   public override object ReadDocument(Stream stream)
   {
      return stream;
   }

   public new void Resolve()
   {
      try
      {
         DiscoveryDocument myDiscoveryRefDocument;
         myDiscoveryRefDocument = base.ClientProtocol.Discover(Url);
      }
      catch (Exception e)
      {
         throw(e);
      }
   }

   protected override void Resolve(string contentType, Stream stream) {}

   public override string Url
   {
      get
      {
         return myDocumentUrl;
      }

      set
      {
         myDocumentUrl = value;
      }
   }

   public override void WriteDocument(object document, System.IO.Stream stream)
   {
      DiscoveryDocument myDiscoveryDocument = (DiscoveryDocument)document;
      myDiscoveryDocument.Write(stream);
   }
}


Visual C++
#using <System.Xml.dll>
#using <System.Web.Services.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Web::Services::Discovery;
using namespace System::Net;

// Class derived from DiscoveryReference class and overriding it members.
ref class MyDiscoveryReferenceClass: public DiscoveryReference
{
private:
   String^ myDocumentUrl;

public:
   property String^ DefaultFilename 
   {
      virtual String^ get() override
      {
         return "dataservice.disco";
      }
   }

   virtual Object^ ReadDocument( Stream^ stream ) override
   {
      return stream;
   }

   void Resolve()
   {
      try
      {
         DiscoveryDocument^ myDiscoveryRefDocument;
         myDiscoveryRefDocument = DiscoveryReference::ClientProtocol->Discover( Url );
      }
      catch ( Exception^ e ) 
      {
         throw e;
      }
   }

protected:
   virtual void Resolve( String^ /*contentType*/, Stream^ /*stream*/ ) override {}

public:
   property String^ Url 
   {
      virtual String^ get() override
      {
         return myDocumentUrl;
      }

      virtual void set( String^ value ) override
      {
         myDocumentUrl = value;
      }
   }

   virtual void WriteDocument( Object^ document, System::IO::Stream^ stream ) override
   {
      DiscoveryDocument^ myDiscoveryDocument = dynamic_cast<DiscoveryDocument^>(document);
      myDiscoveryDocument->Write( stream );
   }
};

int main()
{
   try
   {
      DiscoveryDocument^ myDiscoveryDocument;
      StreamReader^ myStreamReader = gcnew StreamReader( "c:\\Inetpub\\wwwroot\\dataservice.disco" );
      FileStream^ myStream = gcnew FileStream( "c:\\MyDiscovery.disco",FileMode::OpenOrCreate );
      Console::WriteLine( "Demonstrating DiscoveryReference class." );

      // Read discovery file.
      myDiscoveryDocument = DiscoveryDocument::Read( myStreamReader );

      // Create a new instance of the DiscoveryReference class.
      MyDiscoveryReferenceClass^ myDiscoveryReference;
      myDiscoveryReference = gcnew MyDiscoveryReferenceClass;
      DiscoveryClientProtocol^ myDiscoveryClientProtocol = gcnew DiscoveryClientProtocol;
      myDiscoveryClientProtocol->Credentials = CredentialCache::DefaultCredentials;

      // Set the client protocol.
      myDiscoveryReference->ClientProtocol = myDiscoveryClientProtocol;

      // Read the default file name.
      Console::WriteLine( "Default file name is: {0}", myDiscoveryReference->DefaultFilename );

      // Write the document.
      myDiscoveryReference->WriteDocument( myDiscoveryDocument, myStream );

      // Read the document.
      myDiscoveryReference->ReadDocument( myStream );

      // Set the URL.
      myDiscoveryReference->Url = "http://localhost/dataservice.disco";
      Console::WriteLine( "Url is: {0}", myDiscoveryReference->Url );

      // Resolve the URL.
      myDiscoveryReference->Resolve();
      myStreamReader->Close();
      myStream->Close();
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "Exception caught! - {0}", e->Message );
   }
}


CPP_OLD
#using <mscorlib.dll>
#using <System.Xml.dll>
#using <System.Web.Services.dll>
#using <System.dll>
using namespace System;
using namespace System::IO;
using namespace System::Web::Services::Discovery;
using namespace System::Net;

// Class derived from DiscoveryReference class and overriding it members.
__gc class MyDiscoveryReferenceClass : public DiscoveryReference
{
private:
   String* myDocumentUrl;
public:
   __property String* get_DefaultFilename()
   {
      return S"dataservice.disco";
   }

   Object* ReadDocument(Stream* stream)
   {
      return stream;
   }

   void Resolve()
   {
      try
      {
         DiscoveryDocument* myDiscoveryRefDocument;
         myDiscoveryRefDocument = DiscoveryReference::ClientProtocol->Discover(Url);
      }
      catch (Exception* e)
      {
         throw(e);
      }
   }

protected:
   void Resolve(String* /*contentType*/, Stream* /*stream*/) {}

public:
   __property String* get_Url()
   {
      return myDocumentUrl;
   }

   __property void set_Url( String* value )
   {
      myDocumentUrl = value;
   }

   void WriteDocument(Object* document, System::IO::Stream* stream)
   {
      DiscoveryDocument* myDiscoveryDocument = dynamic_cast<DiscoveryDocument*>(document);
      myDiscoveryDocument->Write(stream);
   }
};

int main()
{
   try {
      DiscoveryDocument* myDiscoveryDocument;
      StreamReader* myStreamReader =
         new StreamReader(S"c:\\Inetpub\\wwwroot\\dataservice.disco");
      FileStream* myStream = new FileStream(S"c:\\MyDiscovery.disco",
         FileMode::OpenOrCreate);
      Console::WriteLine(S"Demonstrating DiscoveryReference class.");

      // Read discovery file.
      myDiscoveryDocument = DiscoveryDocument::Read(myStreamReader);

      // Create a new instance of the DiscoveryReference class.
      MyDiscoveryReferenceClass* myDiscoveryReference;
      myDiscoveryReference =  new MyDiscoveryReferenceClass();

      DiscoveryClientProtocol* myDiscoveryClientProtocol =
         new DiscoveryClientProtocol();
      myDiscoveryClientProtocol->Credentials =
         CredentialCache::DefaultCredentials;

      // Set the client protocol.
      myDiscoveryReference->ClientProtocol = myDiscoveryClientProtocol;

      // Read the default file name.
      Console::WriteLine(S"Default file name is: {0}", myDiscoveryReference->DefaultFilename);

      // Write the document.
      myDiscoveryReference->WriteDocument(myDiscoveryDocument,myStream);

      // Read the document.
      myDiscoveryReference->ReadDocument(myStream);

      // Set the URL.
      myDiscoveryReference->Url = S"http://localhost/dataservice.disco";
      Console::WriteLine(S"Url is: {0}", myDiscoveryReference->Url);

      // Resolve the URL.
      myDiscoveryReference->Resolve();

      myStreamReader->Close();
      myStream->Close();
   }
   catch (Exception* e)
   {
      Console::WriteLine(S"Exception caught! - {0}", e->Message);
   }
}


Inheritance Hierarchy

System.Object
  System.Web.Services.Discovery.DiscoveryReference
    System.Web.Services.Discovery.ContractReference
    System.Web.Services.Discovery.DiscoveryDocumentReference
    System.Web.Services.Discovery.SchemaReference
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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
See Also

Reference