DiscoveryReference Class

Reference

Definition

Namespace:: System.Web.Services.Discovery

Assembly:: System.Web.Services.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.

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

public ref class DiscoveryReference abstract

public abstract class DiscoveryReference

type DiscoveryReference = class

Public MustInherit Class DiscoveryReference

Inheritance: Object
DiscoveryReference

Derived: System.Web.Services.Discovery.ContractReference

System.Web.Services.Discovery.DiscoveryDocumentReference

System.Web.Services.Discovery.SchemaReference

Examples

#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 );
   }
}

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);
   }
}

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

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.

Constructors

DiscoveryReference()

Initializes a new instance of the DiscoveryReference class.

Properties

ClientProtocol	Gets or sets the instance of DiscoveryClientProtocol used in a discovery process.
DefaultFilename	Gets the name of the default file to use when saving the referenced discovery document, XSD schema, or Service Description.
Url	Gets or sets the URL of the referenced document.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FilenameFromUrl(String)	Returns a file name based on the passed URL.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ReadDocument(Stream)	Reads the passed Stream and returns an instance of the class representing the type of referenced document.
Resolve()	Downloads the referenced document at Url to resolve whether the referenced document is valid.
Resolve(String, Stream)	Resolves whether the referenced document is valid.
ToString()	Returns a string that represents the current object. (Inherited from Object)
WriteDocument(Object, Stream)	When overridden in a derived class, writes the document to a Stream.

Applies to

Jaa